TSRecorderWr::ITSRecorderWr Interface Reference

ITSRecorder interface. More...

Public Member Functions
bool	Activate (String^ appName, String^ licPath, String^ Key)
	Activate KlvPlayer license. More...
String	GetNodeInfo ()
bool	Init (NetSourcePropsWr^ SrcProps, FileTargetPropsWr^ tgtProps)
	Init input parameters. More...
bool	SetRecaster (NetRecasterPropsWr^ recastProps)
	SetRecaster input parameters. More...
bool	Start ()
	Start Recording. More...
void	Stop ()
	Stop Recording. More...
__int64	GetTotalReceivedSize ()
	GetTotalReceivedSize. More...
__int64	GetTotalRecordedSize ()
	GetTotalRecordedSize. More...
__int64	GetCurrentSegmentReceivedSize ()
	GetCurrentSegmentReceivedSize. More...
__int64	GetCurrentSegmentRecordedSize ()
	GetCurrentSegmentRecordedSize. More...
int	GetProgress ()
	GetProgress. More...
unsigned long	GetCurrentSegmentIndex ()
	GetCurrentSegmentIndex. More...
String	GetCurrentSegmentPath ()
	GetCurrentSegmentName. More...
double	GetRecordingBitrate ()
	GetRecordingBitrate. More...
void	Close ()
	Close recorder. More...

Public Attributes
event NotifyRecorderEvent	RecorderEvent
	Recorder Event.
event NotifyError	ErrorEvent
	Error Event.
property Object	Id { Object^ get()
property String	Name { String^ get()
property Recorder_State	RecorderState
property TimeSpan	SessionDuration { TimeSpan get()
property String	LastError { String^ get()
property NetSourcePropsWr	SourceProps { NetSourcePropsWr^ get()
property FileTargetPropsWr	TargetProps { FileTargetPropsWr^ get()

Detailed Description

ITSRecorder interface represents the abstract base class from which Recording operations can inherit. ITSRecorder defines a recorder interface. The derived TSRecorder implements recorder methods and notification events.

Member Function Documentation

Activate()

bool TSRecorderWr::ITSRecorderWr::Activate	(	String^	appName,
		String^	licPath,
		String^	Key
	)

Activates KlvPlayer features according to the license

Parameters

appName	a String^. Application name.
licPath	a String^. License file path.
licPath	a String^. License Key.

Returns

bool.

Close()

void TSRecorderWr::ITSRecorderWr::Close

(

)

Close recorder and release the resources

Returns

void.

GetCurrentSegmentIndex()

unsigned long TSRecorderWr::ITSRecorderWr::GetCurrentSegmentIndex

(

)

Return current segment index

Returns

unsigned long. Current segment index.

GetCurrentSegmentPath()

String TSRecorderWr::ITSRecorderWr::GetCurrentSegmentPath

(

)

Returns current segment name

Returns

String^ . Current segment name.

GetCurrentSegmentReceivedSize()

__int64 TSRecorderWr::ITSRecorderWr::GetCurrentSegmentReceivedSize

(

)

returns a number of bytes received during current segment processing.

Returns

__int64.

GetCurrentSegmentRecordedSize()

__int64 TSRecorderWr::ITSRecorderWr::GetCurrentSegmentRecordedSize

(

)

returns a number of bytes recorded during current segment processing.

Returns

__int64.

GetProgress()

int TSRecorderWr::ITSRecorderWr::GetProgress

(

)

GetProgress returns the current recording progress (calculated by size or segment duration)

Returns

int64.

GetRecordingBitrate()

double TSRecorderWr::ITSRecorderWr::GetRecordingBitrate

(

)

Return average recording bitrate

Returns

double. Bitrate since the last request.

GetTotalReceivedSize()

__int64 TSRecorderWr::ITSRecorderWr::GetTotalReceivedSize

(

)

returns the number of bytes received ( from the last StartRecording request )

Returns

__int64.

GetTotalRecordedSize()

__int64 TSRecorderWr::ITSRecorderWr::GetTotalRecordedSize

(

)

returns the number of bytes already recorded from the last StartRecording request

Returns

__int64.

Init()

bool TSRecorderWr::ITSRecorderWr::Init	(	NetSourcePropsWr^	SrcProps,
		FileTargetPropsWr^	tgtProps
	)

Initialize with a File or a UDP Stream

Parameters

SrcProps	a NetSourcePropsWr^. Network source paramaters.
tgtProps	a FileTargetPropsWr^. File Target paramaters.

Returns

bool.

SetRecaster()

bool TSRecorderWr::ITSRecorderWr::SetRecaster

(

NetRecasterPropsWr^

recastProps

)

Initialize Recaster

Parameters

recastProps

a NetRecasterPropsWr^. Network recast target paramaters.

Returns

bool.

Start()

bool TSRecorderWr::ITSRecorderWr::Start

(

)

Starts recording the input to a target file

Returns

bool.

Stop()

void TSRecorderWr::ITSRecorderWr::Stop

(

)

Stops recording

Returns

void.