javax.telephony.media.async
Interface Async_Player

All Superinterfaces:

CoderConstants, MediaConstants, PlayerConstants, ResourceConstants

All Known Subinterfaces:

Async_TTSPlayer

public interface Async_Player

extends PlayerConstants

Non-blocking methods for the Player resource. When complete, the Async_PlayerEvents are delivered to Async_PlayerListener.onPlayDone(). or PlayerListener.on<RTCaction>Done()

Since:

JTAPI-1.4

Fields inherited from interface javax.telephony.media.PlayerConstants

a_Coder, a_DictionaryList, a_Jump, a_LoadedDictionary, a_Pause, a_SapiOptions, a_Speed, a_Volume, e_Busy, ev_ActivateDictionary, ev_AdjustSpeed, ev_AdjustVolume, ev_Jump, ev_LoadDictionary, ev_Marker, ev_Pause, ev_Play, ev_Resume, ev_Speed, ev_Stop, ev_UnloadDictionary, ev_Volume, p_CoderTypes, p_EnabledEvents, p_IfBusy, p_JumpMDO, p_JumpMDOIncrement, p_JumpMSCIncrement, p_JumpSentence, p_JumpTime, p_JumpWord, p_MaxDuration, p_SpeedChange, p_StartPaused, p_VolumeChange, q_Duration, q_EndOfData, rtca_JumpBackwardMDOs, rtca_JumpBackwardMSCs, rtca_JumpBackwardSentences, rtca_JumpBackwardTime, rtca_JumpBackwardWords, rtca_JumpEndMDO, rtca_JumpEndMDOList, rtca_JumpEndMSC, rtca_JumpEndMSCList, rtca_JumpEndSentence, rtca_JumpForwardMDOs, rtca_JumpForwardMSCs, rtca_JumpForwardSentences, rtca_JumpForwardTime, rtca_JumpForwardWords, rtca_JumpStartMDO, rtca_JumpStartMDOList, rtca_JumpStartMSC, rtca_JumpStartMSCList, rtca_JumpStartSentence, rtca_NormalSpeed, rtca_NormalVolume, rtca_Pause, rtca_Resume, rtca_SpeedDown, rtca_SpeedUp, rtca_Stop, rtca_ToggleSpeed, rtca_ToggleVolume, rtca_VolumeDown, rtca_VolumeUp, rtcc_PlayComplete, rtcc_PlayStarted, v_Class, v_Fail, v_Queue, v_Stop

Fields inherited from interface javax.telephony.media.ResourceConstants

e_Disconnected, FOREVER, q_Disconnected, q_RTC, rtcc_Disconnected, rtcc_TriggerRTC, v_Forever

Fields inherited from interface javax.telephony.media.MediaConstants

e_OK, q_Standard, q_Stop

Fields inherited from interface javax.telephony.media.CoderConstants

v_24kADPCM, v_32kADPCM, v_44kADPCM, v_48k8BitLinear, v_48kALawPCM, v_48kMuLawPCM, v_64k8BitLinear, v_64kALawPCM, v_64kMuLawPCM, v_88k8BitLinear, v_88kALawPCM, v_88kMuLawPCM, v_ADPCM_24k, v_ADPCM_32k, v_ADPCM_44k, v_ADSI, v_ALawPCM_48k, v_ALawPCM_64k, v_ALawPCM_88k, v_ASCII, v_Linear8Bit_48k, v_Linear8Bit_64k, v_Linear8Bit_88k, v_MuLawPCM_48k, v_MuLawPCM_64k, v_MuLawPCM_88k, v_TDD

Method Summary

Async_PlayerEvent	async_adjustPlayerSpeed(Symbol adjustment) Non-blocking version of Player.adjustPlayerSpeed.
Async_PlayerEvent	async_adjustPlayerVolume(Symbol adjustment) Non-blocking version of Player.adjustPlayerVolume.
Async_PlayerEvent	async_jumpPlayer(Symbol jump) Non-blocking version of Player.jumpPlayer.
Async_PlayerEvent	async_pausePlayer() Non-blocking version of Player.pausePlayer.
Async_PlayerEvent	async_play(java.lang.String[] streamIDs, int offset, RTC[] rtc, java.util.Dictionary optargs) Non-blocking version of Play(); Play an array of MDOs named by Strings.
Async_PlayerEvent	async_play(java.lang.String streamID, int offset, RTC[] rtc, java.util.Dictionary optargs) Play a single MDO (Media Data Object) named by streamID.
Async_PlayerEvent	async_resumePlayer() Non-blocking version of Player.resumePlayer.
Async_PlayerEvent	async_stopPlayer() Non-blocking version of Player.stopPlayer.

Method Detail

async_play

public Async_PlayerEvent async_play(java.lang.String[] streamIDs,
                                    int offset,
                                    RTC[] rtc,
                                    java.util.Dictionary optargs)

Non-blocking version of Play(); Play an array of MDOs named by Strings.

Completion event is sent to Async_PlayerListener.

Parameters:

streamIDs - a String[] naming the MDO list to be played.

offset - number of milliseconds into the MDO list at which play is to start, offset may span several items in streamIDs.

rtc - Array of RTC that effect this play.

optargs - a Dictionary of optional arguments.

Returns:

an Async_PlayerEvent

See Also:

Player.play(String[], int, RTC[], Dictionary)

async_play

public Async_PlayerEvent async_play(java.lang.String streamID,
                                    int offset,
                                    RTC[] rtc,
                                    java.util.Dictionary optargs)

Play a single MDO (Media Data Object) named by streamID. Equivalent to async_play() with a String[] of length one, containing the given streamID.

Parameters:

streamID - a String naming the MDO to be played.

offset - int number milliseconds into the MDO at which play is to start.

rtc - Array of RTC that effect this play.

optargs - a Dictionary of optional arguments.

Returns:

a Player.Event when the operation is complete (or queued).

See Also:

Player.play(String, int, RTC[], Dictionary)

async_adjustPlayerSpeed

public Async_PlayerEvent async_adjustPlayerSpeed(Symbol adjustment)

Non-blocking version of Player.adjustPlayerSpeed.

Parameters:

adjustment - a Symbol specifying the type of adjustment

Returns:

Async_PlayerEvent

See Also:

Player.adjustPlayerSpeed(javax.telephony.media.Symbol)

async_adjustPlayerVolume

public Async_PlayerEvent async_adjustPlayerVolume(Symbol adjustment)

Non-blocking version of Player.adjustPlayerVolume.

Parameters:

adjustment - a Symbol specifying the type of adjustment

Returns:

Async_PlayerEvent

See Also:

Player.adjustPlayerVolume(javax.telephony.media.Symbol)

async_jumpPlayer

public Async_PlayerEvent async_jumpPlayer(Symbol jump)

Non-blocking version of Player.jumpPlayer.

Parameters:

jump - a Symbol specifying the type of jump

Returns:

Async_PlayerEvent

See Also:

Player.jumpPlayer(javax.telephony.media.Symbol)

async_pausePlayer

public Async_PlayerEvent async_pausePlayer()

Non-blocking version of Player.pausePlayer.

Returns:

Async_PlayerEvent

See Also:

Player.pausePlayer()

async_resumePlayer

public Async_PlayerEvent async_resumePlayer()

Non-blocking version of Player.resumePlayer.

Returns:

Async_PlayerEvent

See Also:

Player.resumePlayer()

async_stopPlayer

public Async_PlayerEvent async_stopPlayer()

Non-blocking version of Player.stopPlayer.

Returns:

Async_PlayerEvent

See Also:

Player.stopPlayer()