Click or drag to resize

PhoneCallStateWavePlayer Class

Plays arbitrary looped wave files when the attached call changes its state.
Inheritance Hierarchy
SystemObject
  DisposableClass
    AbstractMediaSenderAudioData, AudioFormat
      AudioSender
        Ozeki.MediaMediaStreamSender
          Ozeki.MediaTimerBasedMediaStreamHandler
            Ozeki.MediaAudioStreamPlayback
              Ozeki.MediaWaveStreamPlayback
                Ozeki.VoIPPhoneCallStateWavePlayer

Namespace:  Ozeki.VoIP
Assembly:  OzekiSDK (in OzekiSDK.dll) Version: 10.3.183.0
Syntax
public sealed class PhoneCallStateWavePlayer : WaveStreamPlayback, 
	IPhoneCallAttachable

The PhoneCallStateWavePlayer type exposes the following members.

Constructors
  NameDescription
Public methodPhoneCallStateWavePlayer
Initializes a new instance of the PhoneCallStateWavePlayer class.
Public methodPhoneCallStateWavePlayer(WaveFormat, DictionaryCallState, Stream, DictionaryCallState, Stream)
Initializes a new instance of the PhoneCallStateWavePlayer class.
Public methodPhoneCallStateWavePlayer(WaveFormat, DictionaryCallState, String, DictionaryCallState, String)
Initializes a new instance of the PhoneCallStateWavePlayer class.
Public methodPhoneCallStateWavePlayer(ICall, WaveFormat, DictionaryCallState, Stream, DictionaryCallState, Stream)
Initializes a new instance of the PhoneCallStateWavePlayer class and attaches to a call object.
Public methodPhoneCallStateWavePlayer(ICall, WaveFormat, DictionaryCallState, String, DictionaryCallState, String)
Initializes a new instance of the PhoneCallStateWavePlayer class and attaches to a call object.
Top
Properties
  NameDescription
Public propertyCached
Gets a boolean value indicating whether the playback stream is cached in the memory.
(Inherited from AudioStreamPlayback.)
Public propertyCall
Gets or sets the attached call.
Public propertyHasActualCall
Gets a boolean value indicating whether the attached activeCall is not null.
Public propertyID (Inherited from DisposableClass.)
Protected propertyInterval
Gets the time between the send events (in milliseconds).
(Inherited from TimerBasedMediaStreamHandler.)
Public propertyIsStreaming
Gets or sets a value that is true if the wave is streaming, otherwise false.
(Inherited from MediaStreamSender.)
Public propertyLoop
A boolean value indicating whether the playback is repeated infinetly.
(Inherited from AudioStreamPlayback.)
Protected propertyMediaFormat (Inherited from AudioStreamPlayback.)
Public propertyOutputFormat (Inherited from MediaStreamSender.)
Protected propertyPosition
Gets or sets the current position in the audio stream
(Inherited from MediaStreamSender.)
Public propertyStream
Gets the stream
(Inherited from MediaStreamSender.)
Top
Methods
  NameDescription
Public methodAttachToCall
Attaches this object to the given phone call.
Public methodDetach
Detaches the object from the attached call.
Public methodDispose (Inherited from DisposableClass.)
Protected methodDispose(Boolean)
Disposes the object.
(Overrides TimerBasedMediaStreamHandlerDispose(Boolean).)
Protected methodFinalize (Inherited from DisposableClass.)
Protected methodGetAudioData (Inherited from AudioStreamPlayback.)
Public methodGetAudioFormat (Inherited from MediaStreamSender.)
Protected methodLoadReader
Initializes the file reader which will read the content of the stream. (This method will be invoked in the LoadStream(Stream) method.)
(Inherited from WaveStreamPlayback.)
Public methodLoadStream (Inherited from AudioStreamPlayback.)
Public methodPause
Pauses the streaming. (If the streaming is already paused then does nothing.)
(Inherited from MediaStreamSender.)
Protected methodReceiverConnected (Inherited from AudioSender.)
Protected methodReceiverDisconnected (Inherited from AudioSender.)
Protected methodSendMediaData (Inherited from AbstractMediaSenderAudioData, AudioFormat.)
Protected methodSetPlaybackWaveStream
Changes the playback stream to the given stream.
(Inherited from AudioStreamPlayback.)
Public methodSetPreferredSendFormats (Inherited from AbstractMediaSenderAudioData, AudioFormat.)
Public methodSetStateStreams
Sets files for the states of the activeCall.
Public methodStart
Starts the stream given in the Stream property. (If the stream is already started then does nothing.)
(Inherited from TimerBasedMediaStreamHandler.)
Public methodStop
Stops the streaming.
(Inherited from TimerBasedMediaStreamHandler.)
Protected methodTimerTick
This will be called when the built-in timer ticks.
(Inherited from AudioStreamPlayback.)
Public methodUpdateIncomingStateStream
Updates one wave file name for the given state for the activeCall.
Public methodUpdateOutgoingStateStream
Updates one wave file name for the given state for the activeCall.
Top
Events
  NameDescription
Public eventMediaDataSent (Inherited from AbstractMediaSenderAudioData, AudioFormat.)
Public eventStopped
Occurs when the audio recording or playing has been stopped
(Inherited from MediaStreamSender.)
Top
Fields
  NameDescription
Protected fieldbuffer (Inherited from AudioStreamPlayback.)
Protected fieldSync (Inherited from MediaStreamSender.)
Top
See Also