IMScenes

Operates mixer scenes

Methods

ScenesActiveGet

Gets the active scene.

Syntax

void ScenesActiveGet( 
   out string _pbsSceneID,
   out int _pnIndex,
   out IMElements _ppScene
)

Parameters

_pbsSceneID - ID of the scene
_pnIndex - index of the scene
_ppScene - scene object

ScenesActiveSet

Sets the active scene.

Syntax

void ScenesActiveSet( 
   string _bsSceneID,
   string _bsParameters
)

Parameters

_bsSceneID - ID of the scene
_bsParameters - parameters of the scene

ScenesAdd

Adds a new scene.

Syntax

void ScenesAdd( 
   string _bsXMLDescOrPathName,
   out string _pbsSceneID,
   out IMElements _ppScene
)

Parameters

_bsXMLDescOrPathName - description of the scene as XML string or path to file with the description
_pbsSceneID - ID of the scene
_ppScene - scene object

ScenesElementGetByPos

Gets element of active scene by its screen position.

Syntax

void ScenesElementGetByPos( 
   double _dblPosX,
   double _dblPosY,
   int _bHiddenReturn,
   out MElement _ppElement
)

Parameters

_dblPosX - X coordinate of the pointer
_dblPosY - Y coordinate of the pointer
_bHiddenReturn - "1" is to return a hidden element and "0" to not return a hidden element
_ppElement - element of the scene

ScenesGet

Gets the scene by its ID.

Syntax

void ScenesGet( 
   string _bsSceneID,
   out IMElements _ppScene
)

Parameters

_bsSceneID - ID of the scene
_ppScene - scene object

ScenesGetByIndex

Gets the scene by its index.

Syntax

void ScenesGetByIndex( 
   int _nIndex,
   out string _pbsSceneID,
   out IMElements _ppScene
)

Parameters

_nIndex - index of the scene
_pbsSceneID - ID of the scene
_ppScene - scene object

ScenesGetCount

Gets the count of scenes.

Syntax

void ScenesGetCount( 
   out int _pnCount
)

Parameters

_pnCount - number of scenes

ScenesRemove

Removes the scene.

Syntax

void ScenesRemove( 
   string _bsSceneID
)

Parameters

_bsSceneID - ID of the scene