Methods > Casting > CastingCreateFromStreamMixer method

Remarks

Creates a casting session that will output sound from the given stream mixer.

After creating the casting session, you can start it through the CastingStart method.

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.

Syntax

[Visual Basic]

Public Function CastingCreateFromStreamMixer (

nStreamMixerID as Int16,

strServer as String,

strPassword as String,

strIcecastMountName as String,

nEncodeFormat as enumEncodingFormats,

strName as String,

strURL as String,

strGenre as String,

strHeaders as String,

strIcecastDescription as String,

nEncodeMode as enumCastEncodeModes,

fEncodeValue as float,

nResampleFrequency as Int32,

nChannels as Int16

) as Int32

[C#]

public Int32 CastingCreateFromStreamMixer (

Int16 nStreamMixerID,

string strServer,

string strPassword,

string strIcecastMountName,

enumEncodingFormats nEncodeFormat,

string strName,

string strURL,

string strGenre,

string strHeaders,

string strIcecastDescription,

enumCastEncodeModes nEncodeMode,

float fEncodeValue,

Int32 nResampleFrequency,

Int16 nChannels

);

[C++]

public: Int32 CastingCreateFromStreamMixer (

Int16 nStreamMixerID,

string strServer,

string strPassword,

string strIcecastMountName,

enumEncodingFormats nEncodeFormat,

string strName,

string strURL,

string strGenre,

string strHeaders,

string strIcecastDescription,

enumCastEncodeModes nEncodeMode,

float fEncodeValue,

Int32 nResampleFrequency,

Int16 nChannels

);

Parameter

Description

nStreamMixerID

Unique identifier of the stream mixer

strServer

URL of the cast server

strPassword

Password of the cast server

strIcecastMountName

Icecast mount name (for use with Icecast servers only)

nEncodeFormat

Encoding format

Supported values are the following:

Mnemonic constant	Value	Meaning
ENCODING_FORMAT_MP3	2	MP3 format
ENCODING_FORMAT_OGG	4	OGG Vorbis format

strName

Stream name

strURL

URL of the radio station

strGenre

Genre of the stream

strHeaders

Additional headers to send to the server

strIcecastDescription

Further description for Icecast streams (for use with Icecast servers only)

nEncodeMode

Encode mode

Supported values are the following:

Mnemonic constant	Value	Meaning
CAST_ENCODE_QUALITY	0	Casting is based upon Quality
CAST_ENCODE_BITRATE	1	Casting is based upon Bitrate

fEncodeValue

Value related to the chosen encode mode

nResampleFrequency

Resample frequency

nChannels

Number of channels

Return value

Value	Meaning

> 0	Numeric value representing the unique identifier of the casting session: this unique identifier will be used in order to invoke further methods related to the use of the casting session itself
Negative value	An error occurred: see the LastError property for further error details or for a list of the possible error values.