|
VideoPlayer.OSDItemAlphaSet method |
  
|
|
VideoPlayer.OSDItemAlphaSet method |
|
Remarks
Sets the alpha channel transparency applied to the graphical item on the On-Screen-Display (OSD). The current value can be obtained through the VideoPlayer.OSDItemAlphaGet method.
For further details about the use of the embedded video player see the VideoPlayer class section.
For details about video clips rendering refer to the How to play video files through DirectShow tutorial.
Syntax
[Visual Basic] Public Function OSDItemAlphaSet ( nPlayerIndex as Int16, nItemUniqueId as Int32, nAlpha as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes OSDItemAlphaSet ( Int16 nPlayerIndex, Int32 nItemUniqueId, Int16 nAlpha ); |
[C++] public: enumErrorCodes OSDItemAlphaSet ( Int16 nPlayerIndex, Int32 nItemUniqueId, Int16 nAlpha ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that will use the video player. |
nItemUniqueId |
Unique identifier of the item returned by a previous call to one between the following methods: VideoPlayer.OSDItemPictureFileAdd, VideoPlayer.OSDItemBitmapAdd, VideoPlayer.OSDItemTextAdd, VideoPlayer.OSDItemOutlineTextAdd or VideoPlayer.OSDItemRectangleAdd |
nAlpha |
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. |
