|
VideoPlayer.OSDItemBitmapGet method |
  
|
|
VideoPlayer.OSDItemBitmapGet method |
|
Remarks
Obtains the bitmap for an existing graphical item previously added to the On-Screen-Display (OSD) through a call to the VideoPlayer.OSDItemBitmapAdd or VideoPlayer.OSDItemPictureFileAdd or VideoPlayer.OSDItemPictureMemoryAdd methods.
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 OSDItemBitmapGet ( nPlayerIndex as Int16, nItemUniqueId as Int32, hBitmap as IntPtr, nOriginalWidth as Int32, nOriginalHeight as Int32, nResizeWidth as Int32, nResizeHeight as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes OSDItemBitmapGet ( Int16 nPlayerIndex, Int32 nItemUniqueId, ref IntPtr hBitmap, ref Int32 nOriginalWidth, ref Int32 nOriginalHeight, Int32 nResizeWidth, Int32 nResizeHeight ); |
[C++] public: enumErrorCodes OSDItemBitmapGet ( Int16 nPlayerIndex, Int32 nItemUniqueId, IntPtr __gc *hBitmap, Int32 __gc *nOriginalWidth, Int32 __gc *nOriginalHeight, Int32 nResizeWidth, Int32 nResizeHeight ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that will use the video player. |
nItemUniqueId |
Unique identifier of item returned by a previous call to the VideoPlayer.OSDItemBitmapAdd method |
hBitmap |
Reference that, on return from the method call, will contain the handle of the bitmap (HBITMAP). |
nOriginalWidth |
Reference that, on return from the method call, will contain the original width, expressed in pixels, of the picture |
nOriginalHeight |
Reference that, on return from the method call, will contain the original height, expressed in pixels, of the picture |
nResizeWidth |
Width, expressed in pixels, for resizing the picture before returning the HBITMAP; ignored if set to 0 |
nResizeHeight |
Height, expressed in pixels, for resizing the picture before returning the HBITMAP; ignored if set to 0 |
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 |
