IToiAudioOverlayService Interface Reference


Description

Technical Preview:
This interface is a TECHNICAL PREVIEW, it may change. Plays an audio sample file.

import "IToiAudioOverlayService.idl";

List of all members.

Public Member Functions

void Play (in string file, in boolean loop)
void Stop ()
void RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException)
void ReleaseObserver (in string address) raises (TToiInvalidArgumentException)

Member Function Documentation

void IToiAudioOverlayService::Play ( in string  file,
in boolean  loop 
)

Plays an audio file if the format is supported. Any current active playback will be stopped.

Parameters:
file The audio file to play.
loop Indicates wheter the audio should be looped.
void IToiAudioOverlayService::RegisterObserver ( in IToiApplicationService::TToiApplicationId  applicationId,
in string  address 
) raises (TToiInvalidArgumentException)

Register an observer of type IToiAudioOverlayObserver. The observer will receive events sent by this IToiAudioOverlayService instance.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiAudioOverlayService can find an IToiAudioOverlayObserver 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:
IToiAudioOverlayObserver
void IToiAudioOverlayService::ReleaseObserver ( in string  address  )  raises (TToiInvalidArgumentException)

Release an observer previously registered with RegisterObserver.

Parameters:
address The address where the IToiAudioOverlayService can find the registered IToiAudioOverlayObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiAudioOverlayObserver
void IToiAudioOverlayService::Stop (  ) 

Stops any current active playback.