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

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.String,RecordingModeStart>
      com.avaya.conferencing.api.acp.control.operations.RecordingModeStart

All Implemented Interfaces:

Operation<java.lang.String,RecordingModeStart>, java.lang.Cloneable

public final class RecordingModeStart
extends AbstractOperationImpl<java.lang.String,RecordingModeStart>

Starts recording a 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 setRecordingServer(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 RecordPlaybackServers allow recordings to be terminated by DTMF codes (except analog recordings, other recordings 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 a recording.

You can set the 'recordingFileName' property (see setRecordingName(java.lang.String)) to the file you want the recording placed into. For some RecordPlaybackServers, the 'recordingFileName' is not required. For those where it is required, but not supplied, a default file name will be allocated on starting the recording.

The operation will return the filename that the recording is being placed in. The filename will also be set as a property of the Conference. As stated, in some RecordPlaybackServers, there is no file created (at least on the ConferencingProvider's file system, there isn't!). In those cases, the filename will be returned by the operation as null.

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'.
java.lang.String	getRecordingName() Getter for property 'recordingName'.
RecordPlaybackServer	getRecordingServer() Getter for property 'recordingServer'.
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'.
void	setRecordingName(java.lang.String recordingName) Setter for property 'recordingName'.
void	setRecordingServer(RecordPlaybackServer recordingServer) Setter for property 'recordingServer'.

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

getRecordingName

public java.lang.String getRecordingName()

Getter for property 'recordingName'.

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

Returns:

Value for property 'recordingName'.

Since:

5.1.0.0.29

setRecordingName

public void setRecordingName(java.lang.String recordingName)

Setter for property 'recordingName'.

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

Parameters:

recordingName - Value to set for property 'recordingName'.

Since:

5.1.0.0.29

getRecordingServer

public RecordPlaybackServer getRecordingServer()

Getter for property 'recordingServer'.

This property tells the operation which RecordPlaybackServer to perform 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 recordingName, 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

setRecordingServer

@Required
public void setRecordingServer(RecordPlaybackServer recordingServer)

Setter for property 'recordingServer'.

This property tells the operation which RecordPlaybackServer to perform 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 recordingName, etc.). Any properties that are not required by a particular RecordPlaybackServer will simply be ignored.

Parameters:

recordingServer - Value to set for property 'recordingServer'

Since:

5.1.0.0.29

isDTMFEnabled

public boolean isDTMFEnabled()

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

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

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

Returns:

Value for property 'allowModeratorDTMF'

Since:

5.1.0.0.29

setDTMFEnabled

public void setDTMFEnabled(boolean dtmfEnabled)

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

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

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

Parameters:

dtmfEnabled - Value to set for property 'allowModeratorDTMF'

Since:

5.1.0.0.29

getMessageSet

public java.lang.Short getMessageSet()

Getter for property 'messageSet'. This property tells the recording server what message set to apply the recording to.

This property only has relevance for some RecordPlaybackServer types (see setRecordingServer(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 recording server what message set to apply the recording to.

This property only has relevance for some RecordPlaybackServer types (see setRecordingServer(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