Ozeki VoIP SDK Class library
PhoneCallStateWavePlayer Class
NamespacesOzeki.Media.MediaHandlersPhoneCallStateWavePlayer
Plays arbitrary looped wave files when the attached call changes its state.
Declaration Syntax
C#Visual BasicVisual C++
public sealed class PhoneCallStateWavePlayer : WaveStreamPlayback, 
	IPhoneCallAttachable
Public NotInheritable Class PhoneCallStateWavePlayer _
	Inherits WaveStreamPlayback _
	Implements IPhoneCallAttachable
public ref class PhoneCallStateWavePlayer sealed : public WaveStreamPlayback, 
	IPhoneCallAttachable
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
PhoneCallStateWavePlayer()()()()
Initializes a new instance of the PhoneCallStateWavePlayer class.

PhoneCallStateWavePlayer(WaveFormat, Dictionary<(Of <<'(CallState, String>)>>), Dictionary<(Of <<'(CallState, String>)>>))
Initializes a new instance of the PhoneCallStateWavePlayer class.

PhoneCallStateWavePlayer(IPhoneCall, WaveFormat, Dictionary<(Of <<'(CallState, String>)>>), Dictionary<(Of <<'(CallState, String>)>>))
Initializes a new instance of the PhoneCallStateWavePlayer class and attaches to a call object.

PhoneCallStateWavePlayer(WaveFormat, Dictionary<(Of <<'(CallState, Stream>)>>), Dictionary<(Of <<'(CallState, Stream>)>>))
Initializes a new instance of the PhoneCallStateWavePlayer class.

PhoneCallStateWavePlayer(IPhoneCall, WaveFormat, Dictionary<(Of <<'(CallState, Stream>)>>), Dictionary<(Of <<'(CallState, Stream>)>>))
Initializes a new instance of the PhoneCallStateWavePlayer class and attaches to a call object.

AttachToCall(ICall)
Attaches this object to the given phone call.

Cached
Gets a boolean value indicating whether the playback stream is cached in the memory.
(Inherited from AudioStreamPlayback.)
Call
Gets or sets the attached call.

DataReceived(Object, VoIPEventArgs<(Of <<'(AudioData>)>>))
This will be called when media data received from a media handler.
(Inherited from AudioStreamPlayback.)
DataSent
Event that occurs when the data is ready to send.
(Inherited from AudioHandler.)
Detach()()()()
Detaches the object from the attached call.

Dispose(Boolean)
Disposes the object.
(Overrides TimerBasedMediaStreamHandler.Dispose(Boolean).)
Dispose()()()()
Disposes the object.
(Inherited from VoIPMediaHandler.)
Finalize()()()()
(Inherited from VoIPMediaHandler.)
HasActualCall
Gets a boolean value indicating whether the attached activeCall is not null.

Interval
Gets the time between the send events (in milliseconds).
(Inherited from TimerBasedMediaStreamHandler.)
IsStreaming
Gets or sets a value that is true if the wave is streaming, otherwise false.
(Inherited from MediaStreamHandler.)
LoadReader(Stream)
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.)
Loop
A boolean value indicating whether the playback is repeated infinetly.
(Inherited from AudioStreamPlayback.)
MediaFormat
Gets the MediaFormat of the media handler.
(Inherited from AudioHandler.)
MediaFormatChanged
Occurs when the MediaFormat of the media handler has changed.
(Inherited from AudioHandler.)
PauseStreaming()()()()
Pauses the streaming. (If the streaming is already paused then does nothing.)
(Inherited from MediaStreamHandler.)
Position
Gets or sets the current position in the audio stream
(Inherited from MediaStreamHandler.)
SendData(AudioData)
Sends media data to the connected media handlers.
(Inherited from AudioHandler.)
SetPlaybackWaveStream(WaveFileStream)
Changes the playback stream to the given stream.
(Inherited from AudioStreamPlayback.)
SetStateStreams(Dictionary<(Of <<'(CallState, String>)>>), Dictionary<(Of <<'(CallState, String>)>>))
Sets files for the states of the activeCall.

StartStreaming()()()()
Starts the streaming. (If the streaming is already started then does nothing.)
(Inherited from MediaStreamHandler.)
Stopped
Occurs when the audio recording or playing has been stopped
(Inherited from MediaStreamHandler.)
StopStreaming()()()()
Stops the streaming. (If the streaming is already stopped then does nothing.)
(Inherited from MediaStreamHandler.)
Stream
Gets the stream
(Inherited from MediaStreamHandler.)
TimerTick(Object, EventArgs)
This will be called when the built-in timer ticks.
(Inherited from AudioStreamPlayback.)
UpdateIncomingStateStream(CallState, String)
Updates one wave file name for the given state for the activeCall.

UpdateOutgoingStateStream(CallState, String)
Updates one wave file name for the given state for the activeCall.

Inheritance Hierarchy

Assembly: VoIPSDK (Module: VoIPSDK) Version: 10.0.6.243