Avaya Conferencing Provider API

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

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.Boolean,PlaybackModeStop>
      extended by com.avaya.conferencing.api.acp.control.operations.PlaybackModeStop
All Implemented Interfaces:
Operation<java.lang.Boolean,PlaybackModeStop>, java.lang.Cloneable

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

Stops an ongoing (or paused) playback.

The operation will return a Boolean indicating whether the playback was stopped 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.
 Verb getVerb()
          This gets the verb that describes this operation.
 boolean isAsModerator()
          Returns the asModerator of this PlaybackModeStop object.
 void setAsModerator(boolean asModerator)
          Setter for the property 'asModerator'.
 
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

isAsModerator

public boolean isAsModerator()
Returns the asModerator of this PlaybackModeStop object.

Returns:
The asModerator of this PlaybackModeStop object.
Since:
5.1.0.0.29

setAsModerator

public void setAsModerator(boolean asModerator)

Setter for the property 'asModerator'.

It is important to note that, the value in this property MUST be the same as the one in the 'dtmfEnabled' property of the StartRecording operation.

Parameters:
asModerator - The value to place in property 'asModerator'.
Since:
5.1.0.0.29

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

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.