StreamerLib.IStreamingSession Class Reference

Contains an interface definition for Streaming session. More...

Public Member Functions
bool	Activate (string appName, string licPath, string Key)
	Activate StreamingSession license. More...
void	SetMode (STREAMING_MODE mode)
	SetMode sets streaming mode. More...
void	AddSourceSegment (string path, TimeSpan start, TimeSpan stop, int bitrate=0, int avgBitrate=0)
	AddSourceSegment. More...
void	AddTarget (string nic, string ip, int port, int pcktSize, short ttl)
	AddTarget. More...
void	Init ()
	Init. More...
void	Start (TimeSpan? offset=null)
	Start. More...
void	Stop ()
	Stop. More...
void	Pause ()
	Pause. More...
bool	Seek (TimeSpan offset)
	Seek. More...
bool	Move (Int32 i)
	Move. More...
void	Reset ()
	Reset. More...
bool	SetStreamingRate (double rate)
	Set Streaming Rate. More...
double	GetStreamingRate ()
	Init. More...
MediaParams	DetectMediaParams (string path)
	Detect Media Params. More...

Properties
bool	Loop [get, set]
	Loop. More...
object	Id [get, set]
	Streamer identificator.
STREAMER_SESSION_STATE	State [get]
	Streamer state.
TimeSpan	SegmentPosition [get]
	A position inside the current segment.
TimeSpan	Position [get]
	A position inside the playlist.
TimeSpan	Duration [get]
	Total playlist duration.
Int64	BytesSent [get]
	Total bytes sent.
long	CurrentBitrate [get]
	Current streaming bitrate.
Int32	CurrentSegment [get]
	Current segment number.
string	Path [get]
	Current segment pathr.
List< StreamerSource >	GetSourceList [get]
	Returns a list of source segments.
List< StreamerTarget >	GetTargetList [get]
	Returns a list of streaming targets.

Events
SessionStatusChangeEventHandler	SessionStatusChangedEvent
	Session Status Changed Event. More...
SessionSegmentChangeEventHandler	SessionSegmentChangedEvent
	Session Segment Changed Event. More...
SessionErrorEventHandler	SessionErrorEvent
	Session Error Event. More...

Detailed Description

Contains an interface definition for Streaming session

Member Function Documentation

Activate()

bool StreamerLib.IStreamingSession.Activate	(	string	appName,
		string	licPath,
		string	Key
	)

Activates StreamingSession features according to the license

Parameters

appName	a string. Application name.
licPath	a string. License file path.
licPath	a string. License Key.

Returns

bool.

AddSourceSegment()

void StreamerLib.IStreamingSession.AddSourceSegment	(	string	path,
		TimeSpan	start,
		TimeSpan	stop,
		int	bitrate = 0,
		int	avgBitrate = 0
	)

Add Source Segment ( file ) to the streamer's play list.

Parameters

path	a string. File path.
start	a TimeSpan. Start offset.
stop	a TimeSpan. End offset.
bitrate	an int. File bitrate. Note, if bitrate (or duration ) = 0, they will be calculated during the initialization.As bitrate detection takes time, it is better to provide it (if available). It is also possible
average	bitrate an int. File average bitrate. to have it detected for the first time, and then read it back, so it could be stored at the application level and reused later.

Returns

void.

AddTarget()

void StreamerLib.IStreamingSession.AddTarget	(	string	nic,
		string	ip,
		int	port,
		int	pcktSize,
		short	ttl
	)

Add streaming target. This method allows streaming toward more than one destination.

Parameters

nic	a string. Metwork interface.
ip	a string. IP.
port	an int. Port.
pcktSize	an int. Packet size.
ttl	a short. Ttl.

Returns

void.

Note

Having multiple targets requires more processing power and may affect the streaming quality!

DetectMediaParams()

MediaParams StreamerLib.IStreamingSession.DetectMediaParams

(

string

path

)

Detects / Calculates TS Media params

Parameters

path	a string. File path.

Returns

MediaParams.

GetStreamingRate()

double StreamerLib.IStreamingSession.GetStreamingRate

(

)

Initialize a streaming session

Returns

void.

Init()

void StreamerLib.IStreamingSession.Init

(

)

Initialize streaming session. If no bitrate (or duration) info provided while adding the source segements (set to 0), it is calculated during the initialization. As bitrate detection takes time, it is better to provide it (if available). It is also possible to have it detected for the first time, and then read it back, so it could be stored at the application level and reused later.

Returns

void.

Move()

bool StreamerLib.IStreamingSession.Move

(

Int32

i

)

go to a specific segment in the list

Parameters

i	an int. Segment to move to.

Returns

bool.

Pause()

void StreamerLib.IStreamingSession.Pause

(

)

Pauses streaming session

Returns

void.

Reset()

void StreamerLib.IStreamingSession.Reset

(

)

Resets a streamer

Returns

void.

Seek()

bool StreamerLib.IStreamingSession.Seek

(

TimeSpan

offset

)

Seek to a specific point in the list

Parameters

offset

a TimeSpan. Time offset

Returns

bool.

SetMode()

void StreamerLib.IStreamingSession.SetMode

(

STREAMING_MODE

mode

)

Sets streaming mode

Parameters

mode	a STREAMING_MODE. Streaming mode.

Returns

void.

SetStreamingRate()

bool StreamerLib.IStreamingSession.SetStreamingRate

(

double

rate

)

Sets streaming rate

Parameters

rate	a double. Streaming rate (x realtime)

Returns

bool.

Start()

void StreamerLib.IStreamingSession.Start

(

TimeSpan?

offset = null

)

Starts a streaming session

Parameters

offset

a TimeSpan?. An offset to the specific point in the segment list to start a stream.

Returns

void.

Stop()

void StreamerLib.IStreamingSession.Stop

(

)

Stops streaming session

Returns

void.

Property Documentation

Loop

bool StreamerLib.IStreamingSession.Loop

getset

Repeat streaming session.

Returns

bool.

Event Documentation

SessionErrorEvent

SessionErrorEventHandler StreamerLib.IStreamingSession.SessionErrorEvent

SessionErrorEvent. Raised when error occurs.

SessionSegmentChangedEvent

SessionSegmentChangeEventHandler StreamerLib.IStreamingSession.SessionSegmentChangedEvent

Session Segment Changed Event. Raised when current segment is changed.

SessionStatusChangedEvent

SessionStatusChangeEventHandler StreamerLib.IStreamingSession.SessionStatusChangedEvent

Session Status Changed Event. Raised when streamer status is changed.