IToiMediaRecorderBase Interface Reference


Description

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

See also:
IToiMediaService
IToiMediaRecorder

import "IToiMediaRecorderBase.idl";

List of all members.

Public Member Functions

void GetState (out TToiMediaRecorderState state)
void GetSessionId (out IToiMediaSession::TToiSessionId id) raises (TToiSessionViolationException)
void GetUrl (out string url) raises (TToiSessionViolationException)
void GetAssetId (out string assetId) raises (TToiSessionViolationException)
void GetParameter (in string name, out string value) raises (TToiInvalidArgumentException)
void SubscribeParameter (in string address, in string name) raises (TToiInvalidArgumentException)
void UnsubscribeParameter (in string address, in string name) raises (TToiInvalidArgumentException)
void ReleaseInstance ()
void RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException)
void ReleaseObserver (in string address) raises (TToiInvalidArgumentException)

Public Types

enum  TToiMediaRecorderState {
  STATE_IDLE, STATE_CONNECTING, STATE_PAUSED, STATE_RECORDING,
  STATE_FAILED
}
typedef TToiMediaRecorderState TState

Member Enumeration Documentation

State identifier used to identify the media recorder state.

Enumerator:
STATE_IDLE 

In 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 STATE_IDLE.

STATE_CONNECTING 

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

STATE_PAUSED 

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

STATE_RECORDING 

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

STATE_FAILED 

In 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.


Member Function Documentation

void IToiMediaRecorderBase::GetAssetId ( out string  assetId  )  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.
void IToiMediaRecorderBase::GetParameter ( in string  name,
out string  value 
) 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:
IToiMediaRecorder::SetParameter()
IToiMediaRecorder::UnsetParameter()
SubscribeParameter()
void IToiMediaRecorderBase::GetSessionId ( out IToiMediaSession::TToiSessionId  id  )  raises (TToiSessionViolationException)

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

Return values:
id The session identifier.
Exceptions:
TToiSessionViolationException If the player is in STATE_IDLE a session violation exception is raised.
See also:
IToiMediaService::OpenSession()
void IToiMediaRecorderBase::GetState ( out TToiMediaRecorderState  state  ) 

Returns the current state of the media recorder instance.

Return values:
state The current recorder state.
void IToiMediaRecorderBase::GetUrl ( out string  url  )  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 IToiMediaRecorderBase::RegisterObserver ( in IToiApplicationService::TToiApplicationId  applicationId,
in string  address 
) raises (TToiInvalidArgumentException)

Register an observer of type IToiMediaRecorderObserver. The observer will receive events sent by this IToiMediaRecorderBase instance.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiMediaRecorderBase can find an IToiMediaRecorderObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address.
See also:
IToiMediaRecorderObserver
void IToiMediaRecorderBase::ReleaseInstance (  ) 

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

void IToiMediaRecorderBase::ReleaseObserver ( in string  address  )  raises (TToiInvalidArgumentException)

Release an observer previously registered with RegisterObserver.

Parameters:
address The address where the IToiMediaRecorderBase can find the registered IToiMediaRecorderObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiMediaRecorderObserver
void IToiMediaRecorderBase::SubscribeParameter ( in string  address,
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 IToiMediaRecorderObserver::OnParameterChanged() if there is a value available.

Parameters:
address The observer address of the parameter that is subscribed.
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:
UnsubscribeParameter()
void IToiMediaRecorderBase::UnsubscribeParameter ( in string  address,
in string  name 
) raises (TToiInvalidArgumentException)

This function undoes the effect of a previous call to SubscribeParameter().

Parameters:
address The observer address of the parameter that is unsubscribed.
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:
SubscribeParameter()