Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control
Class RecordPlaybackServer

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.AbstractConferencingObject<RecordPlaybackServer>
      extended by com.avaya.conferencing.api.acp.control.RecordPlaybackServer
All Implemented Interfaces:
ConferencingObject<RecordPlaybackServer>

public abstract class RecordPlaybackServer
extends AbstractConferencingObject<RecordPlaybackServer>

An interface defining resources that support recording and playback and the operations they support.

Since:
5.1.0.0.29

Nested Class Summary
static interface RecordPlaybackServer.Feature
          Marker interface for RecordPlaybackServer features.
static class RecordPlaybackServer.Features
          Features of a RecordPlaybackServer published by the API.
 
Field Summary
static java.lang.String ACTIVE
          The property name for isActive().
static java.lang.String FEATURES
          The property name for getFeatures().
static java.lang.String NAME
          The property name for getName().
 
Fields inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject
VERBOSE_TO_STRING
 
Fields inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject
STATE
 
Constructor Summary
RecordPlaybackServer()
           
 
Method Summary
 java.util.Set<RecordPlaybackServer.Feature> getFeatures()
          Returns the features supported by the RecordPlaybackServer.
 java.lang.String getName()
          Method getName returns the name of this MediaSource object.
 boolean isActive()
          Returns true if the MediaSource is connected.
 boolean isAutoGenFileNamesSupported()
          Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.AUTO_GENERATE_FILE_NAME)
 boolean isPauseResumeSupported()
          Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.PAUSE_RESUME)
 boolean isPlaybackSupported()
          Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.PLAYBACK)
 boolean isRecordingSupported()
          Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.RECORDING)
abstract
<S extends ConferencingObject<S>>
boolean
isSupported(java.lang.Class<S> classToCheck)
          Deprecated. as of 5.2.0.0.1, the preference is to use getFeatures().contains(Features.CAN_RECORD_TO_MESSAGE) or getFeatures().contains(Features.CAN_RECORD_FROM_CONFERENCE) etc
 
Methods inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject
equals, execute, getVerbs, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject
addAvailableVerbsChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, executeAs, getAllVerbs, getAllVerbsAs, getAllVerbsAs, getConnection, getId, getProperties, getProperties, getPropertyClass, getPropertyClasses, getPropertyType, getPropertyValue, getPropertyValues, getState, getVerbsAs, removeAvailableVerbsChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener
 

Field Detail

NAME

public static final java.lang.String NAME
The property name for getName().

Since:
5.1.0.0.40

ACTIVE

public static final java.lang.String ACTIVE
The property name for isActive().

Since:
5.1.0.0.40

FEATURES

public static final java.lang.String FEATURES
The property name for getFeatures().

Since:
5.1.1.0.1
Constructor Detail

RecordPlaybackServer

public RecordPlaybackServer()
Method Detail

getName

public final java.lang.String getName()
Method getName returns the name of this MediaSource object.

Returns:
the name (type String) of this MediaSource object.
Since:
5.1.0.0.40

isActive

public final boolean isActive()
Returns true if the MediaSource is connected.

Returns:
true if the MediaSource is connected.
Since:
5.1.0.0.40

getFeatures

public final java.util.Set<RecordPlaybackServer.Feature> getFeatures()
Returns the features supported by the RecordPlaybackServer.

Returns:
the features supported by the RecordPlaybackServer.
Since:
5.1.1.0.1

isAutoGenFileNamesSupported

@Deprecated
public final boolean isAutoGenFileNamesSupported()
Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.AUTO_GENERATE_FILE_NAME)

Tells the caller whether this RecordPlaybackServer supports auto generation of file names for recordings. If this is allowed, but no file name is supplied, the RecordPlaybackServer will automatically generate a file name to record into.

Returns:
Whether recording file names can be automatically generated by the RecordPlaybackServer
Since:
5.1.0.0.29

isPauseResumeSupported

@Deprecated
public final boolean isPauseResumeSupported()
Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.PAUSE_RESUME)

Tells the caller whether this implementation of the RecordPlaybackServer supports Pause and Resume during recording and playback.

Returns:
Whether the Pause/Resume operations are supported by this server.
Since:
5.1.0.0.29

isPlaybackSupported

@Deprecated
public final boolean isPlaybackSupported()
Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.PLAYBACK)

Tells the caller whether this implementation of the RecordPlaybackServer supports the Playback operation.

Returns:
Whether the Playback operation is supported by this server.
Since:
5.1.0.0.29

isRecordingSupported

@Deprecated
public final boolean isRecordingSupported()
Deprecated. as of 5.1.1.0.1, the preference is to use getFeatures().contains(Features.RECORDING)

Tells the caller whether this implementation of the RecordPlaybackServer supports the Record operation.

Returns:
Whether the Record operation is supported by this server.
Since:
5.1.0.0.29

isSupported

public abstract <S extends ConferencingObject<S>> boolean isSupported(java.lang.Class<S> classToCheck)
Deprecated. as of 5.2.0.0.1, the preference is to use getFeatures().contains(Features.CAN_RECORD_TO_MESSAGE) or getFeatures().contains(Features.CAN_RECORD_FROM_CONFERENCE) etc

Tells the caller whether the passed in Class is supported by this RecordPlaybackServer. For example, a RecordPlaybackServer

Parameters:
classToCheck - The Class of the caller.
Returns:
Whether the calling Class is supported by this RecordPlaybackServer.
Since:
5.1.0.0.29

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.