ToiMediaRecorderBase Interface Reference

---

Description

The ToiMediaRecorderBase interface is the base interface for recorder instances. It contains only read-only methods and no control functionality.

See also:

ToiMediaService

ToiMediaRecorder

import "ToiMediaRecorderBase.idl";

Inheritance diagram for ToiMediaRecorderBase:

List of all members.

Public Member Functions
TToiMediaRecorderState	getState ()
ToiMediaSession::TToiSessionId	getSessionId () raises (TToiSessionViolationException)
string	getUrl () raises (TToiSessionViolationException)
string	getAssetId () raises (TToiSessionViolationException)
string	getParameter (in string name) raises (TToiInvalidArgumentException)
void	subscribeParameter (in ToiEventListener eventListener, in string name) raises (TToiInvalidArgumentException)
void	unsubscribeParameter (in ToiEventListener eventListener, in string name) raises (TToiInvalidArgumentException)
void	releaseInstance ()
Public Attributes
Events
const long	ON_STATE_CHANGED = 1800
const long	ON_PARAMETER_CHANGED = 1801
TToiMediaRecorderState
const TToiMediaRecorderState	STATE_IDLE = 0
const TToiMediaRecorderState	STATE_CONNECTING = 1
const TToiMediaRecorderState	STATE_PAUSED = 2
const TToiMediaRecorderState	STATE_RECORDING = 3
const TToiMediaRecorderState	STATE_FAILED = 4
Public Types
typedef long	TToiMediaRecorderState

---

Member Typedef Documentation

typedef long ToiMediaRecorderBase::TToiMediaRecorderState

State identifier used to identify the media recorder state.

---

Member Function Documentation

string ToiMediaRecorderBase::getAssetId

(

)

raises (TToiSessionViolationException)

Returns the asset used for recording.

Return values:

assetId

The asset identifier.

Exceptions:

TToiSessionViolationException

If the recorder is in idle state a session violation exception is raised.

string ToiMediaRecorderBase::getParameter

(

in string

name

)

raises (TToiInvalidArgumentException)

Get the current value of a parameter.

Parameters:

name	Name of the requested parameter.

Return values:

value

The current value of the parameter.

Exceptions:

TToiInvalidArgumentException

The parameter name is invalid or not recognized.

See also:

ToiMediaRecorder::setParameter()

ToiMediaRecorder::unsetParameter()

ToiMediaRecorderBase::subscribeParameter()

ToiMediaSession::TToiSessionId ToiMediaRecorderBase::getSessionId

(

)

raises (TToiSessionViolationException)

Returns the session identifier. This identifier can be used to open a session object with (C++) ToiMediaService::OpenSession().

Return values:

id	The session identifier.

Exceptions:

TToiSessionViolationException

If the player is in ToiMediaRecorderBase::STATE_IDLE a session violation exception is raised.

See also:

ToiMediaService::openSession()

TToiMediaRecorderState ToiMediaRecorderBase::getState

(

)

Returns the current state of the media recorder instance.

Return values:

state

The current recorder state.

string ToiMediaRecorderBase::getUrl

(

)

raises (TToiSessionViolationException)

Returns the URL for the media stream.

Return values:

url	The URL for the media stream.

Exceptions:

TToiSessionViolationException

If the recorder is in idle state a session violation exception is raised.

void ToiMediaRecorderBase::releaseInstance

(

)

This function releases the resources used by this instance. When this function returns all observers has also been released.

void ToiMediaRecorderBase::subscribeParameter	(	in ToiEventListener	eventListener,
		in string	name
	)		raises (TToiInvalidArgumentException)

This function makes the application subscribe to updates of a specific named parameter. When the subscription is made there will be an immediate call to (C++) ToiMediaRecorderObserver::OnParameterChanged() if there is a value available.

Parameters:

eventListener	ToiEventListener
name	The name of the parameter for which changes the application wants to subscribe to.

Exceptions:

TToiInvalidArgumentException

The parameter name is invalid or not recognized.

See also:

ToiMediaRecorderBase::unsubscribeParameter()

void ToiMediaRecorderBase::unsubscribeParameter	(	in ToiEventListener	eventListener,
		in string	name
	)		raises (TToiInvalidArgumentException)

This function undoes the effect of a previous call to ToiMediaRecorderBase::subscribeParameter().

Parameters:

eventListener	ToiEventListener
name	The name of the parameter that the application is no longer interested in.

Exceptions:

TToiInvalidArgumentException

The parameter name is invalid or not recognized.

See also:

ToiMediaRecorderBase::subscribeParameter()

---

Member Data Documentation

const long ToiMediaRecorderBase::ON_PARAMETER_CHANGED = 1801

This is an Event identifier for ToiMediaRecorderParameterChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.ON_PARAMETER_CHANGED.

const long ToiMediaRecorderBase::ON_STATE_CHANGED = 1800

This is an Event identifier for ToiMediaRecorderStateChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.ON_STATE_CHANGED.

const TToiMediaRecorderState ToiMediaRecorderBase::STATE_CONNECTING = 1

In ToiMediaRecorderBase::STATE_CONNECTING the media recorder has an active session and is in the process of establishing a connection to a media stream source.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.STATE_CONNECTING.

const TToiMediaRecorderState ToiMediaRecorderBase::STATE_FAILED = 4

In ToiMediaRecorderBase::STATE_FAILED the media recorder may or may not have a connection to a media source but the process of getting the stream from that source has failed in some fatal way.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.STATE_FAILED.

const TToiMediaRecorderState ToiMediaRecorderBase::STATE_IDLE = 0

In ToiMediaRecorderBase::STATE_IDLE there is no active session. The media recorder does not handle a stream, and consequently has no connection to a media stream source. All functions requiring a session will raise a TToiSessionViolationException in ToiMediaRecorderBase::STATE_IDLE.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.STATE_IDLE.

const TToiMediaRecorderState ToiMediaRecorderBase::STATE_PAUSED = 2

In ToiMediaRecorderBase::STATE_PAUSED the media recorder has a connection to a media source but is not yet recording the stream.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.STATE_PAUSED.

const TToiMediaRecorderState ToiMediaRecorderBase::STATE_RECORDING = 3

In ToiMediaRecorderBase::STATE_RECORDING the media recorder has a connection to a media source and records the stream.

This constant can also be accessed from toi.consts.ToiMediaRecorderBase.STATE_RECORDING.