CastingStart method |
|
Remarks
Starts the casting session created by a previous call to one of the following methods:
• | for stream mixers: CastingCreateFromStreamMixer, CastingWmaPubPointOpenForStreamMixer or CastingWmaNetworkOpenForStreamMixer |
• | for players: CastingCreateFromPlayer, CastingWmaPubPointOpenForPlayer or CastingWmaNetworkOpenForPlayer |
• | for WASAPI loopback devices (Windows Vista and later versions only): CastingCreateFromWasapiLoopback, CastingWmaPubPointOpenFromWasapiLoopback, CastingWmaNetworkOpenFromWasapiLoopback |
A started session can be stopped at any time through the CastingStop method.
The call to this method will generate the following events:
• | If the casting session has been initiated by a custom Stream Mixer, the call to this method will generate the CastingStreamMixerStart event. |
• | If the casting session has been initiated by one of the available players, the call to the this method will generate the CastingPlayerStart event, followed by a number of CastingPlayerPerc event and finally by the CastingPlayerDone event. |
• | If the casting session has been initiated by a WASAPI loopback device, the call to the this method will generate the CastingWasapiLoopbackStart event. |
Further information about management of casting sessions can be found inside the How to use the control as a source for streaming servers like SHOUTcast tutorial.
For further details about the use of WASAPI see the WASAPIMan class and the How to manage audio flow through WASAPI tutorial
Syntax
[Visual Basic] Public Function CastingStart ( nCastingUniqueID as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes CastingStart ( Int32 nCastingUniqueID ); |
[C++] public: enumErrorCodes CastingStart ( Int32 nCastingUniqueID ); |
Parameter |
Description |
||||||
|
|
||||||
nCastingUniqueID |
Unique identifier of the casting session returned by a previous call to one of the following methods:
|
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 |