com.arunta.app.remote
Interface TRPlayServiceRI

All Superinterfaces:
java.rmi.Remote

public interface TRPlayServiceRI
extends java.rmi.Remote

Total Recall VR remote interface for playing recordings.

This service provides for real-time playing of recordings of calls that have ended. Use the TRMonitorServiceRI to monitor calls which are being recorded.


Method Summary
 long getAbsoluteStartTime(java.lang.String securityKey, java.lang.String sessionKey)
          Calculates the absolute start time, as milliseconds from epoch, for the audio file(s) when multiplexed in absolute time.
 long getCurrentAbsoluteTime(java.lang.String securityKey, java.lang.String sessionKey)
          Returns the current absolute time, as milliseconds from epoch.
 long getOverallDuration(java.lang.String securityKey, java.lang.String sessionKey)
          Calculates the overall duration, in milliseconds, of the file(s) to play.
 void jumpToAbsoluteTime(java.lang.String securityKey, java.lang.String sessionKey, long time)
          Jumps to the specified absolute time.
 void pause(java.lang.String securityKey, java.lang.String sessionKey)
          Instructs the Total Recall VR system to cease sending stream packets; however, to keep the active StreamPacketSender until further instructions.
 void play(java.lang.String securityKey, java.lang.String sessionKey)
          Instructs the Total Recall VR system to actually start sending stream packets with audio.
 void play(java.lang.String securityKey, java.lang.String sessionKey, long time)
          Instructs the Total Recall VR system to actually start sending stream packets with audio from the specified absolute time.
 java.lang.String startRemotePlayback(java.lang.String securityKey, java.net.InetSocketAddress socketAddress, java.lang.String[] filePaths)
          Instructs the Total Recall VR system to prepare a StreamPacketSender.
 void stop(java.lang.String securityKey, java.lang.String sessionKey)
          Instructs the Total Recall VR system to cease sending stream packets; however, to keep the active StreamPacketSender until further instructions.
 void stopRemotePlayback(java.lang.String securityKey, java.lang.String sessionKey)
          Instructs the Total Recall VR system to stop an active StreamPacketSender and dispose of it.
 

Method Detail

startRemotePlayback

java.lang.String startRemotePlayback(java.lang.String securityKey,
                                     java.net.InetSocketAddress socketAddress,
                                     java.lang.String[] filePaths)
                                     throws java.io.IOException,
                                            TooManySessionsException,
                                            SecurityException,
                                            java.rmi.RemoteException
Instructs the Total Recall VR system to prepare a StreamPacketSender.

The packet sender will send stream packets for the audio in the specified files to the remote client via the specified UDP socket. The client should have a StreamPacketReceiver running on the specified socket before making this request.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
socketAddress - The socket to send packets to. This socket is used by the packet receiver.
filePaths - Set of fully qualified paths to the files to play.
Returns:
A play session key which must be used in all other requests related to the session.
Throws:
java.io.IOException - On any problem accessing the specified files or the data in the files.
TooManySessionsException - If there are too many active play sessions already.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

stopRemotePlayback

void stopRemotePlayback(java.lang.String securityKey,
                        java.lang.String sessionKey)
                        throws SecurityException,
                               java.rmi.RemoteException
Instructs the Total Recall VR system to stop an active StreamPacketSender and dispose of it.

The client should stop the StreamPacketReceiver that it uses to receive the packets from the sender after this request to ensure that it receives all packets sent by the sender.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

play

void play(java.lang.String securityKey,
          java.lang.String sessionKey)
          throws SecurityException,
                 java.rmi.RemoteException
Instructs the Total Recall VR system to actually start sending stream packets with audio.

The first play request for the session instructs the Total Recall VR system to start sending audio from the file with earliest absolute start time and continue until the end of the file with the latest end time multiplexing other files as needed along the way.

However, a play request after pause(String, String) instructs the Total Recall VR system to continue sending audio packets starting from the pause time.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

play

void play(java.lang.String securityKey,
          java.lang.String sessionKey,
          long time)
          throws SecurityException,
                 java.rmi.RemoteException
Instructs the Total Recall VR system to actually start sending stream packets with audio from the specified absolute time.

The Total Recall VR system will start sending audio from the file(s) starting at the specified absolute time and continue until the end of the file with the latest end time multiplexing other files as needed along the way.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
time - The absolute time where play should start.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

stop

void stop(java.lang.String securityKey,
          java.lang.String sessionKey)
          throws SecurityException,
                 java.rmi.RemoteException
Instructs the Total Recall VR system to cease sending stream packets; however, to keep the active StreamPacketSender until further instructions.

Note that the Total Recall VR system does not remember the stop point in absolute time with this request.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

pause

void pause(java.lang.String securityKey,
           java.lang.String sessionKey)
           throws SecurityException,
                  java.rmi.RemoteException
Instructs the Total Recall VR system to cease sending stream packets; however, to keep the active StreamPacketSender until further instructions.

Note that the Total Recall VR system does remember the stop point in absolute time with this request.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getOverallDuration

long getOverallDuration(java.lang.String securityKey,
                        java.lang.String sessionKey)
                        throws SecurityException,
                               java.rmi.RemoteException
Calculates the overall duration, in milliseconds, of the file(s) to play.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Returns:
The overall duration, in milliseconds, of the audio files when multiplexed in absolute time.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getAbsoluteStartTime

long getAbsoluteStartTime(java.lang.String securityKey,
                          java.lang.String sessionKey)
                          throws SecurityException,
                                 java.rmi.RemoteException
Calculates the absolute start time, as milliseconds from epoch, for the audio file(s) when multiplexed in absolute time.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Returns:
The absolute start time, , as milliseconds from epoch.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getCurrentAbsoluteTime

long getCurrentAbsoluteTime(java.lang.String securityKey,
                            java.lang.String sessionKey)
                            throws SecurityException,
                                   java.rmi.RemoteException
Returns the current absolute time, as milliseconds from epoch.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
Returns:
Current absolute time as milliseconds from epoch.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

jumpToAbsoluteTime

void jumpToAbsoluteTime(java.lang.String securityKey,
                        java.lang.String sessionKey,
                        long time)
                        throws SecurityException,
                               java.rmi.RemoteException
Jumps to the specified absolute time.

Subsequent play(String, String) request will start sending stream packets from the specified time.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
sessionKey - The play session key that was obtained from the Total Recall VR system during the startRemotePlayback(String, InetSocketAddress, String[]) request.
time - The time, as milliseconds from epoch, to jump to.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.


Copyright ©, 2005-2012 Prolancer Pty Ltd, Sydney Australia.