|
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] Public Function OSDItemAlphaGet ( nMixerUniqueId as Int32, nItemUniqueId as Int32, ByRef nAlpha as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes OSDItemAlphaGet ( Int32 nMixerUniqueId, Int32 nItemUniqueId, ref Int16 nAlpha ); |
[C++] public: enumErrorCodes OSDItemAlphaGet ( Int32 nMixerUniqueId, Int32 nItemUniqueId, Int16 __gc *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 (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
