Copyright © 2005-2018 MultiMedia Soft

VideoMixer.OSDItemPictureMemoryAdd method

Previous pageReturn to chapter overviewNext page

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 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 OSDItemPictureMemoryAdd (

nMixerUniqueId as Int32,

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 (

Int32 nMixerUniqueId,

byte[] pBuffer,

Int32 nBufferLength,

float fLeftPos,

float fTopPos,

Int16 nAlpha,

Int16 nZOrder,

bool bShow

);


 

[C++]

public: Int32 OSDItemPictureMemoryAdd (

Int32 nMixerUniqueId,

unsigned char __gc[] pBuffer,

Int32 nBufferLength,

float fLeftPos,

float fTopPos,

Int16 nAlpha,

Int16 nZOrder,

bool bShow

);


 

Parameter

Description

 

 

nMixerUniqueId

Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method

pBuffer

Buffer containing the picture file data. The picture can be modified at a later time through the VideoMixer.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 VideoMixer.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 VideoMixer.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 VideoMixer.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 VideoMixer.OSDItemZOrderSet method.

bShow

Boolean flag that specifies if the item must be initially visible or hidden.

Supported values are the following:

Mnemonic constant

Meaning

false

The item is initially kept hidden

true

The item is immediately shown

Visibility can be modified at a later time through the VideoMixer.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