JSR-043: JTAPI-1.4

javax.telephony.media.container
Interface DataObjectEvent

All Superinterfaces:
CoderConstants, ContainerConstants, ContainerEvent, MediaConstants, MediaEvent, MediaServiceConstants
All Known Subinterfaces:
Async_DataObjectEvent

public interface DataObjectEvent
extends ContainerEvent

Defines methods for DataObject events.

Since:
JTAPI-1.4

Fields inherited from interface javax.telephony.media.MediaServiceConstants
ev_BindAndConnect, ev_BindToCall, ev_BindToServiceName, ev_BindToTerminal, ev_BindToTerminalName, ev_Configure, ev_Connected, ev_DelegateToService, ev_Disconnected, ev_GetConfigSpec, ev_GetConfiguration, ev_GetParameters, ev_GetTerminal, ev_GetTerminalName, ev_GetUserValues, ev_GroupStop, ev_Release, ev_ReleaseDelegated, ev_ReleaseToDestroy, ev_ReleaseToService, ev_ReleaseToTag, ev_Retrieve, ev_Retrieved, ev_SetParameters, ev_SetUserDictionary, ev_SetUserValues, ev_TerminalIdle, ev_TriggerRTC
 
Fields inherited from interface javax.telephony.media.MediaConstants
e_OK, q_Duration, q_Standard, q_Stop
 
Fields inherited from interface javax.telephony.media.container.ContainerConstants
b_Append, b_Create, b_Exclusive, b_Truncate, e_OK, k_InputParameters, k_MediaType, k_MediaTypes, v_AccessCopy, v_AccessRead, v_AccessWrite, v_Begin, v_Bytes, v_Create, v_Current, v_End, v_Fail, v_MDO, v_MilliSeconds
 
Fields inherited from interface javax.telephony.media.CoderConstants
v_24kADPCM, v_32kADPCM, v_44kADPCM, v_48k8BitLinear, v_48kALawPCM, v_48kMuLawPCM, v_64k8BitLinear, v_64kALawPCM, v_64kMuLawPCM, v_88k8BitLinear, v_88kALawPCM, v_88kMuLawPCM, v_ADPCM_24k, v_ADPCM_32k, v_ADPCM_44k, v_ADSI, v_ALawPCM_48k, v_ALawPCM_64k, v_ALawPCM_88k, v_ASCII, v_Linear8Bit_48k, v_Linear8Bit_64k, v_Linear8Bit_88k, v_MuLawPCM_48k, v_MuLawPCM_64k, v_MuLawPCM_88k, v_TDD
 
Method Summary
 byte[] getBytesRead()
          Array of bytes read from Data Object.
 int getBytesWritten()
          Number of bytes actually written to Data Object.
 ContainerService getContainerService()
          Return the ContainerService associated with this event.
 DataObject getDataObject()
          Wrap getSource() and cast to a DataObject.
 int getSeekSize()
          Total number of bytes moved during seek.
 
Methods inherited from interface javax.telephony.media.container.ContainerEvent
getError, getEventID, getInfoDict, getObjectList, getParamDict
 
Methods inherited from interface javax.telephony.media.MediaEvent
getException, getPayload, getQualifier, getSubError, getWarning
 

Method Detail

getDataObject

public DataObject getDataObject()
Wrap getSource() and cast to a DataObject.
Specified by:
getDataObject in interface ContainerEvent
Returns:
the DataObject that originated this event.

getContainerService

public ContainerService getContainerService()
Return the ContainerService associated with this event. Shorthand for getDataObject().getContainerService();
Specified by:
getContainerService in interface ContainerEvent
Following copied from interface: javax.telephony.media.container.ContainerEvent
Returns:
the ContainerService that originated this event.

getSeekSize

public int getSeekSize()
Total number of bytes moved during seek. Relative to the seek position.
Returns:
the number of bytes moved during seek.

getBytesRead

public byte[] getBytesRead()
Array of bytes read from Data Object.
Returns:
the array of bytes read

getBytesWritten

public int getBytesWritten()
Number of bytes actually written to Data Object. If less than requested, then an error is indicated and this event should contain an Exception.
Returns:
the number of bytes written

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org