|
VideoPlayer.OSDItemPictureMemoryAdd method |
  
|
|
VideoPlayer.OSDItemPictureMemoryAdd method |
|
Remarks
Adds a new graphical item to the On-Screen-Display (OSD) by getting its representation from a picture file stored inside a memory buffer.
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 OSDItemPictureMemoryAdd ( nPlayerIndex as Int16, pBuffer() as Byte, nBufferLength as Int32, fLeftPos as Single, fTopPos as Single, nAlpha as Int16, nZOrder as Int32, bShow as enumBoolean ) as Int32 |
[C#] public Int32 OSDItemPictureMemoryAdd ( Int16 nPlayerIndex, byte[] pBuffer, Int32 nBufferLength, float fLeftPos, float fTopPos, Int16 nAlpha, Int16 nZOrder, bool bShow ); |
[C++] public: Int32 OSDItemPictureMemoryAdd ( Int16 nPlayerIndex, unsigned char __gc[] pBuffer, Int32 nBufferLength, float fLeftPos, float fTopPos, Int16 nAlpha, Int16 nZOrder, bool bShow ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Number representing the zero-based index of the player that will use the video player. |
||||||
pBuffer |
Variant parameter containing the pointer to the picture file previously loaded in memory. The picture can be modified at a later time through the VideoPlayer.OSDItemPictureMemoryChange method. Accepted picture formats to store inside the memory buffer are BMP, GIF, JPEG and PNG. |
||||||
nBufferLength |
Length in bytes of the given buffer |
||||||
fLeftPos |
Horizontal position, expressed in percentage of the On-Screen-Display (OSD) area, where the item will be rendered. Position can be moved at a later time through the VideoPlayer.OSDItemMove method. |
||||||
fTopPos |
Vertical position, expressed in percentage of the On-Screen-Display (OSD) area, where the item will be rendered. Position can be moved at a later time through the VideoPlayer.OSDItemMove method. |
||||||
nAlpha |
Alpha channel transparency, expressed in percentage, applied to the item when rendered. Values can range from 0 (total opacity) to 100 (total transparency). The alpha channel transparency of the item can be modified at a later time through the VideoPlayer.OSDItemAlphaSet method. |
||||||
nZOrder |
Z-Order of the item. Items with a lower Z-Order value will stay on top respect to other Items having a higher Z-Order value; for example, an Item with Z-Order 0 will stay on top of any other Item but, in case two Items should be assigned the same Z-Order, the latest one having got the same Z-Order will be placed on top of the previous one. The Z-Order of the item can be modified at a later time through the VideoPlayer.OSDItemZOrderSet method. |
||||||
bShow |
Boolean flag that specifies if the item must be initially visible or hidden. Supported values are the following:
Visibility can be modified at a later time through the VideoPlayer.OSDItemShow method. |
Return value
Value |
Meaning |
|
|
0 |
An error occurred (see the LastError property for further error details) |
Other values |
Unique identifier of the graphical item: this unique identifier will be used in order to invoke further methods related to the use of this specific item |
