|
VideoMixer.OSDItemAlphaGet method |
  
|
|
VideoMixer.OSDItemAlphaGet method |
|
Remarks
Obtains the current alpha channel transparency applied to the graphical item on the On-Screen-Display (OSD). The value can be modified through the VideoMixer.OSDItemAlphaSet method.
For further details about the use of the embedded video mixer see the VideoMixer object section.
For details about video mixing/blending refer to the How to use the video mixer tutorial.
Syntax
[Visual Basic] control.VideoMixer.OSDItemAlphaGet ( nMixerUniqueId as Long, nItemUniqueId as Long, nAlpha as Integer ) as enumErrorCodes |
[C++] short control.VideoMixer.OSDItemAlphaGet ( long nMixerUniqueId, long nItemUniqueId, short *nAlpha ); |
Parameter |
Description |
|
|
nMixerUniqueId |
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method |
nItemUniqueId |
Unique identifier of the item returned by a previous call to one between the following methods: VideoMixer.OSDItemPictureFileAdd, VideoMixer.OSDItemBitmapAdd, VideoMixer.OSDItemTextAdd or VideoMixer.OSDItemRectangleAdd |
nAlpha |
Reference that, on return from the method call, will contain the alpha channel transparency expressed in percentage. Values can range from 0 (total opacity) to 100 (total transparency). |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |
