Copyright © 2005-2016 MultiMedia Soft

VideoMixer.PlayerAlphaGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current value of the alpha channel transparency applied to the given player. The value for the alpha channel transparency can be modified through the VideoMixer.PlayerAlphaSet method.

 

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

nMixerUniqueId as Int32,

nPlayerIndex as Int16,

ByRef nAlpha as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayerAlphaGet (

Int32 nMixerUniqueId,

Int16 nPlayerIndex,

ref Int16 nAlpha

);


 

[C++]

public: enumErrorCodes PlayerAlphaGet (

Int32 nMixerUniqueId,

Int16 nPlayerIndex,

Int16 __gc *nAlpha

);


 

Parameter

Description

 

 

nMixerUniqueId

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

nPlayerIndex

Number representing the zero-based index of the player attached to the video mixer through a previous call to the VideoPlayer.AttachToVideoMixer method.

nAlpha

Reference that, on return from the method call, will contain 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.