com.aol.acc
Class AccAvSession

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccSecondarySession
          extended by com.aol.acc.AccAvSession

public class AccAvSession
extends AccSecondarySession

IAccAvSession is used for controlling audio/video calls. Currently this interface
works only on Win32.


Method Summary
 AccAvLocalVideoMode getLocalVideoMode()
          How your own video is displayed to you (or not)
 int getNetworkQuality()
          The "quality" of the AV session, based on latency/packet loss, range is 0-100
 boolean getPromoteCentralized()
          Whether Invite() should cause a move to a centralized conference or not
 AccAvSessionType getSessionType()
          The type of AV session
 AccAvSessionType getSessionTypeProposed()
          The type of AV session that the invitee is proposing to transition to
 boolean getVideo()
          Checks if the AV session is a video session
 AccVariant getVideoWindow(java.lang.String userName)
          Gets the video window for the specified user.
Pass NULL to get your own (preview) window.

 void hold(boolean on)
          Put this session on/off hold.

 void sendDtmf(java.lang.String tones)
          Sends a DTMF sound to the session.

 void sendSoundEffect(java.lang.String url)
          Sends a sound effect to the session.

 void setLocalVideoMode(AccAvLocalVideoMode LocalVideoMode)
          How your own video is displayed to you (or not)
 void setPromoteCentralized(boolean PromoteCentralized)
          Whether Invite() should cause a move to a centralized conference or not
 void startRecording(java.lang.String file)
          Record the sound from the session to a WAV file.

 void stopRecording()
          Stop recording the session.

 
Methods inherited from class com.aol.acc.AccSecondarySession
accept, cancelProposal, eject, endSession, getCreationTime, getInvitation, getInvitees, getLinkedSessions, getMaxParticipantCount, getName, getOnlineTime, getParticipants, getRemainingTime, getRemoteUserName, getSecure, getServiceId, getSession, getSessionState, getState, invite, reject, setLinkedSessions
 
Methods inherited from class com.aol.acc.AccBase
compareHandle, equals
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getVideoWindow

public AccVariant getVideoWindow(java.lang.String userName)
                          throws AccException
Gets the video window for the specified user.
Pass NULL to get your own (preview) window.

Throws:
AccException

sendDtmf

public void sendDtmf(java.lang.String tones)
              throws AccException
Sends a DTMF sound to the session.

Throws:
AccException

sendSoundEffect

public void sendSoundEffect(java.lang.String url)
                     throws AccException
Sends a sound effect to the session.

Throws:
AccException

hold

public void hold(boolean on)
          throws AccException
Put this session on/off hold.

Throws:
AccException

startRecording

public void startRecording(java.lang.String file)
                    throws AccException
Record the sound from the session to a WAV file.

Throws:
AccException

stopRecording

public void stopRecording()
                   throws AccException
Stop recording the session.

Throws:
AccException

getVideo

public boolean getVideo()
                 throws AccException
Checks if the AV session is a video session

Throws:
AccException

getNetworkQuality

public int getNetworkQuality()
                      throws AccException
The "quality" of the AV session, based on latency/packet loss, range is 0-100

Throws:
AccException

getSessionType

public AccAvSessionType getSessionType()
                                throws AccException
The type of AV session

Throws:
AccException

getSessionTypeProposed

public AccAvSessionType getSessionTypeProposed()
                                        throws AccException
The type of AV session that the invitee is proposing to transition to

Throws:
AccException

getPromoteCentralized

public boolean getPromoteCentralized()
                              throws AccException
Whether Invite() should cause a move to a centralized conference or not

Throws:
AccException

setPromoteCentralized

public void setPromoteCentralized(boolean PromoteCentralized)
                           throws AccException
Whether Invite() should cause a move to a centralized conference or not

Throws:
AccException

getLocalVideoMode

public AccAvLocalVideoMode getLocalVideoMode()
                                      throws AccException
How your own video is displayed to you (or not)

Throws:
AccException

setLocalVideoMode

public void setLocalVideoMode(AccAvLocalVideoMode LocalVideoMode)
                       throws AccException
How your own video is displayed to you (or not)

Throws:
AccException