Click or drag to resize

WebRtcChannel Class

[Missing <summary> documentation for "T:VoiceElements.Client.WebRtcChannel"]

Inheritance Hierarchy

Namespace:  VoiceElements.Client
Assembly:  VoiceElementsClient (in VoiceElementsClient.dll) Version: 8.6.1.1
Syntax
public class WebRtcChannel : ChannelResource

The WebRtcChannel type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleAni
This is the originating number of the last inbound call (if available).
(Inherited from ChannelResource.)
Public propertyCallConnected
The time the call connected
(Inherited from ChannelResource.)
Public propertyCallEnd
The time the call was terminated.
(Inherited from ChannelResource.)
Public propertyCode exampleCallerIdName
This is the originating name field of the last inbound call (if available).
(Inherited from ChannelResource.)
Public propertyCallNumber
The call number on the server of the current or last call.
(Inherited from ChannelResource.)
Public propertyCode exampleCallProgress
Gets or Sets the Call Progress Mode for this channel.
(Inherited from ChannelResource.)
Public propertyCode exampleCallProgressOverrides
A serializable object that provides override information to the call progress template. This is used to override Dialogic call progress settings for the next call.
(Inherited from ChannelResource.)
Public propertyCode exampleCallProgressTemplate
Gets or sets the call progress template to use as a basis for the next call. This is used to override Dialogic call progress settings.
(Inherited from ChannelResource.)
Public propertyCallStart
The time the call was started.
(Inherited from ChannelResource.)
Public propertyConference
Represents the Conference of which this resource is a member.
(Inherited from RoutableResource.)
Public propertyConferenceAttributes
Represents the Conference Attributes of a Conference to which this resource is a member.
(Inherited from RoutableResource.)
Public propertyDeviceName
The unique name of this resource / device on the server. This is useful for following, logging a call or thread.
(Inherited from RoutableResource.)
Public propertyDialog
Public propertyCode exampleDialResult
Gets the Dial Result of the last call based on the Call Progress Mode setting.
(Inherited from ChannelResource.)
Public propertyCode exampleDnis
This is the DNIS or the inbound number dialed of the last inbound call.
(Inherited from ChannelResource.)
Public propertyDropError
The Drop Error Code of a disconnected call.
(Inherited from ChannelResource.)
Public propertyCode exampleDropTime
A time at which the server should automatically drop the call whether it is disonnected or not. This value is Universal Time.
(Inherited from ChannelResource.)
Public propertyCode exampleFaxResource
Gets the fax resource associated with this channel. To get a fax resource, call Get Fax Resource Method on this channel.
(Inherited from ChannelResource.)
Public propertyCode exampleGcCause
GC Cause code for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyCode exampleGcCauseMessage
GC Cause message for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyCode exampleGeneralCause
General Cause code for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyCode exampleGeneralCauseMessage
General Cause message for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyIncomingSipHeaders
Public propertyIncomingSipRequestLine
Public propertyListeners
A list of Routable Resources which are currently listening to this resource.
(Inherited from RoutableResource.)
Public propertyListentingTo
A Routable Resources to which this resource is currently listening.
(Inherited from RoutableResource.)
Public propertyCode exampleMaximumTime
Sets the maximum time in seconds to wait for a Dial to complete. Default is 30.
(Inherited from ChannelResource.)
Public propertyOriginatingCallerIdName
Public propertyCode exampleOriginatingPhoneNumber
This is the CallerID number sent with an oubound call when a Dial is executed.
(Inherited from ChannelResource.)
Public propertyOutgoingSipHeaders
Public propertyCode examplePortIndexer
The one based index of this channel on the server.
(Inherited from ChannelResource.)
Public propertyRemoteCallControlAddress
Public propertyRtpAddress
Public propertyRtpCodec
Public propertyRtpPort
Public propertyRtpSdp
Public propertyTransferredCall
A flag to indicate that this call was transferred from another application. If true, TransferredData may contain data passed from the other application.
(Inherited from ChannelResource.)
Public propertyCode exampleTransferredData
Gets the data sent from another application which has invoked the Transfer Application Method to this application.
(Inherited from ChannelResource.)
Public propertyCode exampleVoiceResource
The Voice Resource associated with this channel. Use this for audio functions like play, record and getting digits.
(Inherited from ChannelResource.)
Top
Methods
  NameDescription
Public methodAcceptCall
Public methodCode exampleAnswer
This method is used to pickup an inbound call received on a Channel Resource.
(Inherited from ChannelResource.)
Public methodAnswer(MediaType, MediaOption)
Public methodChangeAudio(RtpType)
Public methodChangeAudio(StreamDuplex)
Public methodChangeAudio(String, Int32)
Public methodChangeAudio(String, Int32, RtpType)
Public methodChangeAudio(String, Int32, RtpType, StreamDuplex)
Public methodChangeAudio(String, Int32, RtpType, StreamDuplex, Boolean)
Public methodChangeAudio(String, Int32, RtpType, StreamDuplex, Boolean, Int32)
Public methodCode exampleDial
Dials the phone number or destination specified in the phonenumber parameter.
(Inherited from ChannelResource.)
Public methodCode exampleDisconnect
This method forces the Channel Resource to disconnect any current connections or calls. You may also think of this as "hanging up."
(Inherited from ChannelResource.)
Public methodCode exampleDisconnect(Int32)
This method forces the Channel Resource to disconnect any current connections or calls. You may also think of this as "hanging up." This overload of the method requires you to specify a numeric cause code to the carrier telling the reason for the disconnect.
(Inherited from ChannelResource.)
Protected methodCode exampleDispose
This method forces a dispose of the Channel Resource object. Always do this in hang up handling to ensure clean up.
(Inherited from ChannelResource.)
Public methodCode exampleGetFaxResource
Retreives a compatible Fax Resource for this Channel. It also sets the Fax Resource Property of the Channel.
(Inherited from ChannelResource.)
Public methodCode exampleIsConnected
Returns the status of any current call. True if a call is connected, false if not connected.
(Inherited from ChannelResource.)
Protected methodProcessCommand
Processes Commands
(Overrides ChannelResource.ProcessCommand(VPacket).)
Public methodRedirect(String)
Public methodRedirect(String)
Public methodRefer(WebRtcChannel)
Public methodRefer(String, String)
Public methodReinvite(WebRtcChannel)
Public methodReinvite(String, String, UInt32, String)
Public methodReinviteHome
Public methodReinviteRefresh
Public methodRouteFull(TelephonyLinkInfo)
This overload is for Voice Elements Internal Use Only! To correctly route, use the Full Route Method.
(Inherited from RoutableResource.)
Public methodCode exampleRouteFull(RoutableResource)
Completes a full route between two Routable Resources. Both channels then listen to each other.
(Inherited from RoutableResource.)
Public methodRouteHalf(TelephonyLinkInfo)
This overload is for Voice Elements Internal Use Only! To correctly route, use the Half Route Method.
(Inherited from RoutableResource.)
Public methodCode exampleRouteHalf(RoutableResource)
Completes a half route between two Routable Resources. The channel calling this method listens to the one in the parameter, the second cannot hear.
(Inherited from RoutableResource.)
Public methodSendChallenge
Send a Authentication Challenge
Public methodSendCustomMessage
Send a custom message
Public methodSendModifyMedia
Send a request to modify the WebRTC Media
Public methodSetConferenceAGCLevels
Sets the levels for the AGC in conferencing. If all values are set to negatives, then the system wide AGC applies.
(Inherited from RoutableResource.)
Public methodSetConferenceECTailDelay
Sets the Echo Tail Delay in conferencing.
(Inherited from RoutableResource.)
Public methodSetConferenceFEGLevel
Sets the front end gain in conferencing. If set to 0, front end gain is turned off.
(Inherited from RoutableResource.)
Public methodCode exampleSetMonitorData
Sets the Monitor Data element for this channel when viewed through the Voice Elements Dashboard. This is a collection of data elements you define to communicate from your application through the VE Dashboard.
(Inherited from ChannelResource.)
Public methodCode exampleSetMonitorStatus
Sets the Monitor Status element for this channel when viewed through the Voice Elements Dashboard.
(Inherited from ChannelResource.)
Public methodStopAllListeners
Forces all Routable Resources currently listening to this resource to stop.
(Inherited from RoutableResource.)
Public methodCode exampleStopDial
Instructs the channel to stop a currently in progress dial.
(Inherited from ChannelResource.)
Public methodStopListener
Forces a apecific Routable Resource currently listening to this resource to stop.
(Inherited from RoutableResource.)
Public methodStopListening
Forces this resource to stop listening to all Routable Resources.
(Inherited from RoutableResource.)
Public methodCode exampleTransferApplication
Transfers the Channel Resource to a different application on the same Telephony Server.
(Inherited from ChannelResource.)
Top
Events
  NameDescription
Public eventCallProgressEvent
Triggered when a Call Progress Event is received
Public eventChallengeEvent
Triggered when challenge event data is received
Public eventCustomMessageEvent
Triggered when a custom message is received
Public eventDialComplete
Event Fired at the completion of a dial operation.
(Inherited from ChannelResource.)
Public eventCode exampleDisconnected
Fires when a call disconnects or hangs up. Do your cleanup in this event code.
(Inherited from ChannelResource.)
Public eventCode exampleNewCall
Fires when there is a new inbound call sent from the Voice Elements Server.
(Inherited from ChannelResource.)
Public eventQosEvent
Top
Fields
  NameDescription
Protected fieldm_DialResult (Inherited from ChannelResource.)
Top
See Also