|
VideoPlayer.OSDEnable method |
  
|
|
VideoPlayer.OSDEnable method |
|
Remarks
Enables/disables the On-Screen-Display (OSD) that will be used to show graphics over the video player rendering window. You can know if the OSD is enabled or disabled through a call to the VideoPlayer.OSDIsEnabled 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 OSDEnable ( nPlayerIndex as Int16, bEnable as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes OSDEnable ( Int16 nPlayerIndex, bool bEnable ); |
[C++] public: enumErrorCodes OSDEnable ( Int16 nPlayerIndex, bool bEnable ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method |
||||||
bEnable |
Boolean value that determines if the OSD is enabled or disabled. Supported values are the following:
|
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. |
