com.avaya.conferencing.api.acp.control.operations
Class PlaybackModeStart

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.Boolean,PlaybackModeStart>
      com.avaya.conferencing.api.acp.control.operations.PlaybackModeStart

All Implemented Interfaces:

Operation<java.lang.Boolean,PlaybackModeStart>, java.lang.Cloneable

public final class PlaybackModeStart
extends AbstractOperationImpl<java.lang.Boolean,PlaybackModeStart>

Starts playing back a previously made recording of the conference.

Not all properties will be required all the time for this operation, depending on the RecordPlaybackServer the operation is being carried out on (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer) for details). In the case where no RecordPlaybackServer has been set, the process acting upon the operation will select an appropriate RecordPlaybackServer itself, depending on the resources available at the time. This RecordPlaybackServer may not have the capabilities you require. You are advised to explicitly set this property.

Some RecordPlaybackServer types allow playback to be terminated by DTMF codes (definitely not analog, others may or may not). This is set with the setDTMFEnabled(boolean) method. The default for this property is to NOT allow this termination, allowing only the API to terminate playback.

You can set the 'recordingFileName' property (see setRecordingURI(java.lang.String)) to the file name you want the recording to play back from. For some RecordPlaybackServer types, the 'recordingFileName' is not required. For those where it is required, it MUST be supplied, otherwise the operation will fail.

The operation will return a Boolean indicating whether the playback started successfully.

Since:

5.1.0.0.29

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation

Operation.Impact

Method Summary

Operation.Impact	getImpact() Returns the impact of the operation.
java.lang.Short	getMessageSet() Getter for property 'messageSet'.This property tells the playback server what message set the playback will be from.
RecordPlaybackServer	getPlaybackServer() Getter for property 'recordingServer'.
java.lang.String	getRecordingURI() Setter for property 'recordingURI'.
Verb	getVerb() This gets the verb that describes this operation.
boolean	isDTMFEnabled() Getter for property 'dtmfEnabled'.
void	setDTMFEnabled(boolean dtmfEnabled) Setter for property 'dtmfEnabled'.
void	setMessageSet(java.lang.Short messageSet) Setter for property 'messageSet'.This property tells the playback server what message set the playback will be from.
void	setPlaybackServer(RecordPlaybackServer playbackServer) Setter for property 'recordingServer'.
void	setRecordingURI(java.lang.String recordingURI) Getter for property 'recordingURI'.

Methods inherited from class com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl

await, await, checkNotSubmitted, checkSubmitted, clone, get, get, isDone, isSubmitted, set, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getPlaybackServer

public RecordPlaybackServer getPlaybackServer()

Getter for property 'recordingServer'.

This property tells the operation which RecordPlaybackServer to play back the recording along. Each RecordPlaybackServer has different capabilities, allowing/restricting allowable operations and relevant properties (for instance, some allow recording, but no playback, others do not require a recordingURI, etc.). Any properties that are not required by a particular RecordPlaybackServer will simply be ignored.

Returns:

The RecordPlaybackServer for the operation.

Since:

5.1.0.0.29

setPlaybackServer

@Required
public void setPlaybackServer(RecordPlaybackServer playbackServer)

Setter for property 'recordingServer'.

This property tells the operation which RecordPlaybackServer to play back the recording along. Each RecordPlaybackServer has different capabilities, allowing/restricting allowable operations and relevant properties (for instance, some allow recording, but no playback, others do not require a recordingURI, etc.). Any properties that are not required by a particular RecordPlaybackServer will simply be ignored.

Parameters:

playbackServer - Value to set for property 'recordingServer'.

Since:

5.1.0.0.29

getRecordingURI

public java.lang.String getRecordingURI()

Setter for property 'recordingURI'.

This property only has relevance for some RecordPlaybackServer types (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer)).

Returns:

Value for property 'recordingURI'.

Since:

5.1.0.0.29

setRecordingURI

@Required
public void setRecordingURI(java.lang.String recordingURI)

Getter for property 'recordingURI'.

This property only has relevance for some RecordPlaybackServer types (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer)).

Parameters:

recordingURI - Value to set for property 'recordingURI'.

Since:

5.1.0.0.29

isDTMFEnabled

public boolean isDTMFEnabled()

Getter for property 'dtmfEnabled'. This property specifies whether to allow DTMF codes to terminate the playback. If false, only the API can stop it. If true, moderators can terminate the playback via DTMF codes (in addition to the API itself).

This field defaults to false, meaning that only the API can terminate a playback.

This property only has relevance for some RecordPlaybackServer types (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer)).

Returns:

Value for property 'dtmfEnabled'

Since:

5.1.0.0.29

setDTMFEnabled

public void setDTMFEnabled(boolean dtmfEnabled)

Setter for property 'dtmfEnabled'. This property specifies whether to allow DTMF codes to terminate the playback. If false, only the API can stop it. If true, moderators can terminate the playback via DTMF codes (in addition to the API itself).

This field defaults to false, meaning that only the API can terminate a playback.

This property only has relevance for some RecordPlaybackServer types (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer)).

Parameters:

dtmfEnabled - Value to set for property 'dtmfEnabled'

Since:

5.1.0.0.29

getMessageSet

public java.lang.Short getMessageSet()

Getter for property 'messageSet'.This property tells the playback server what message set the playback will be from.

This property only has relevance for some RecordPlaybackServer types (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer)).

Returns:

Value for property 'messageSet'

Since:

5.2.0.0.1

setMessageSet

public void setMessageSet(java.lang.Short messageSet)

Setter for property 'messageSet'.This property tells the playback server what message set the playback will be from.

This property only has relevance for some RecordPlaybackServer types (see setPlaybackServer(com.avaya.conferencing.api.acp.control.RecordPlaybackServer)).

Parameters:

messageSet - Value to set for property 'messageSet'

Since:

@since 5.2.0.0.1

getImpact

public Operation.Impact getImpact()

Returns the impact of the operation.

Returns:

the impact.

Since:

5.1.0.0.29

getVerb

public Verb getVerb()

This gets the verb that describes this operation. Multiple operations may return the same verb, however verbs must be unique across the preferred operations. That is only one prefered operation may implement the "mute" verb. There may be deprecated operations that implement the "mute" verb but these will be less performant as they will be implemented as wrappers for the preferred "mute" operation.

Returns:

the verb that describes the operation.

Since:

5.1.0.0.29