AudioVideoCall Class

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.AudioVideo

Assembly:: Microsoft.Rtc.Collaboration.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

AudioVideoCall class is the class which supports the audio-based and video-based communication.

public ref class AudioVideoCall : Microsoft::Rtc::Collaboration::Call

public class AudioVideoCall : Microsoft.Rtc.Collaboration.Call

type AudioVideoCall = class
    inherit Call

Public Class AudioVideoCall
Inherits Call

Inheritance: Object

Call
AudioVideoCall

Remarks

AudioVideoCall is an implementation of the abstract Call class. It implements signaling for audio and video calls. Actual audio and video is exchanged on an instance of AudioVideoFlow, which is created at the time when the call is established.

Constructors

AudioVideoCall(Conversation)

Creates a new instance of the AudioVideoCall and binds this call to the given conversation.

Properties

ActiveMediaTypes	Obsolete. Gets the list of active media types for the call. (Inherited from Call)
ApplicationContext	Gets or sets an application-defined context. (Inherited from Call)
AudioVideoMcuRouting	Gets the audio-video MCU routing object associated with this call.
CallId	Gets the CallId of the primary SIP session used by the call. (Inherited from Call)
CanBeDeflected	Gets whether the call has potential to be deflected to some other target than the original target.
CanHandleTransferReceived	Gets whether call is handling the incoming refer messages.
Conversation	Gets the conversation that contains this call. (Inherited from Call)
DefaultMediaType	Gets or sets the default media type for this call.
Flow	Gets the audio video flow associated with this call.
IsEarlyMediaSupported	Gets whether the call supports the reliable provisional response for early media. (Inherited from Call)
IsReplacesSupported	Gets whether the local endpoint supports the call replacement feature. (Inherited from Call)
IsThirdPartyCallControl	Gets whether the call is used in a third-party call control scenario. (Inherited from Call)
IsUsingGeneratedIdentity	Gets whether the call is using a generated identity during call establishment to a trusted conference.
LocalTag	Gets the local tag of the primary session. (Inherited from Call)
OriginalDestinationUri	Gets the original destination URI of the call. (Inherited from Call)
RemoteEndpoint	Gets the remote endpoint of the call. (Inherited from Call)
RemoteEndpointProperties	Gets the call-specific properties of the remote participant endpoint of this call. (Inherited from Call)
RemoteTag	Gets the remote tag of the primary session. (Inherited from Call)
RouteSetStatus	Gets the status of the dialog's route set. (Inherited from Call)
State	Gets the current state of the call. (Inherited from Call)
SupportedMediaTypes	Gets the list of supported Media names, which are acceptable m-lines in SDP offer/answer.

Methods

BeginAccept(AsyncCallback, Object)	Accepts an incoming call. (Inherited from Call)
BeginAccept(CallAcceptOptions, AsyncCallback, Object)	Accepts an incoming call with given options. (Inherited from Call)
BeginEstablish(AsyncCallback, Object)	Establishes an outgoing call. (Inherited from Call)
BeginEstablish(AudioVideoCallEstablishOptions, AsyncCallback, Object)	Establishes an outgoing call using audio-video call specific options.
BeginEstablish(CallEstablishOptions, AsyncCallback, Object)	Establishes an outgoing call with given options. (Inherited from Call)
BeginEstablish(CallOrbit, CallEstablishOptions, AsyncCallback, Object)	Initiates a call retrival request to the provisioned call park server using the given orbit information.
BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object)	Establishes an outgoing call. (Inherited from Call)
BeginEstablishEarlyMedia(AsyncCallback, Object)	Sends a provisional reliable response with a 183 response code SessionProgress; also creates an early dialog.
BeginEstablishEarlyMedia(CallProvisionalResponseOptions, AsyncCallback, Object)	Sends a provisional reliable response with a 183 response code SessionProgress; will also create an early dialog.
BeginEstablishEarlyMedia(Int32, CallProvisionalResponseOptions, AsyncCallback, Object)	Sends a provisional reliable response on the call; will also create an early dialog.
BeginHandleTermination(AsyncCallback, Object)	Handles audio-video call specific termination.
BeginPark(CallParkOptions, AsyncCallback, Object)	Initiates a park request to the provisioned call park server.
BeginSendInfo(ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object)	Obsolete. Sends an INFO message to the remote participant of this call. (Inherited from Call)
BeginSendMessage(MessageType, ContentDescription, CallSendMessageRequestOptions, AsyncCallback, Object)	Initiates an operation to send message to the remote participant of this call.
BeginSendMessage(MessageType, ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object)	Send a message to the remote participant specified. (Inherited from Call)
BeginSendReliableProvisionalResponse(Int32, Boolean, CallProvisionalResponseOptions, AsyncCallback, Object)	This method can be used to send a reliable provisional response with option to send answer for early media. If the inviter supports 100rel and the local policy is not unsupported, this method will wait for the PRACK. Otherwise, this method will not require 100rel. Any application that supports 100rel is recommended to use this method for sending provisional response. SendProvisional method can be used only when the application knows for sure that the remote does not require 100rel. (Inherited from Call)
BeginTerminate(AsyncCallback, Object)	Terminates the call. After the call is terminated it is no longer usable. (Inherited from Call)
BeginTerminate(CallTerminateOptions, AsyncCallback, Object)	Terminates the call. After the call is terminated it is no longer usable. (Inherited from Call)
BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object)	Terminates the call. After the call is terminated it is no longer usable. (Inherited from Call)
BeginTransfer(Call, AsyncCallback, Object)	Initiates a transfer request to the remote participant.
BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object)	Initiates a transfer request to the remote participant.
BeginTransfer(String, AsyncCallback, Object)	Initiates an attended transfer request to the remote participant.
BeginTransfer(String, CallTransferOptions, AsyncCallback, Object)	Initiates a transfer request to the remote participant.
BindMediaProvider(MediaProvider)	Binds a user-specified media provider to the call. (Inherited from Call)
Decline()	Declines an incoming call with a 603 response code (DeclineEverywhere). (Inherited from Call)
Decline(CallDeclineOptions)	Declines an incoming call with options. (Inherited from Call)
EndAccept(IAsyncResult)	Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed (Inherited from Call)
EndEstablish(IAsyncResult)	Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed. (Inherited from Call)
EndEstablishEarlyMedia(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
EndHandleTermination(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.
EndPark(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
EndSendInfo(IAsyncResult)	Obsolete. Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed. (Inherited from Call)
EndSendMessage(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
EndSendReliableProvisionalResponse(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed (Inherited from Call)
EndTerminate(IAsyncResult)	Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed. (Inherited from Call)
EndTransfer(IAsyncResult)	This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed
Forward(String, CallForwardOptions)	Redirect the audiovideo call to a different target URI.
Forward(String)	Forward the call to the specified target URI with a response code of 303.
GetActiveMediaTypes()	Gets the active media types for the call. (Inherited from Call)
GetMediaForDialReplaces()	Gets the media to be offered by the MCU for dial out replacements.
GetNewEarlyDialog()	Returns the dialog context for the new early dialog. (Inherited from Call)
GetTraceCorrelationID()	Gets the trace correlation id for this instance. (Inherited from Call)
HandleCallMessageReceived(CallMessageReceivedEventArgs)	Handles call messages that are received.
HandleFlowConfigurationRequested(MediaFlow)	This method handles flow created event reported by the provider via the base call.
HandleForwardReceived(CallForwardReceivedEventArgs)	A method that must be implemented by the derived class to handle the forward response received for a call.
HandleMessageReceived(MessageReceivedEventArgs)	Obsolete. Handles a message received event in a class derived from the call class. (Inherited from Call)
HandleStateChange(CallStateChangedEventArgs)	Indicates a state change in an instance of a class derived from the Call class. (Inherited from Call)
HandleTransferNotificationReceived(TransferStateChangedEventArgs)	A method that must be implemented by the derived class to handle the notifications received for a transfer operations sent.
HandleTransferReceived(CallTransferReceivedEventArgs)	A method must be implemented by the derived class to handle the transfer received event. The subclass is responsible for either rejecting the event without exposing it to the application, or raising a strongly typed event.
IsSupportedMediaType(String)	Determines whether the given media type is present in the list of supported media types. (Inherited from Call)
MakeCallback(AsyncCallback, IAsyncResult)	Invokes a specified call using the application's queue for the events. (Inherited from Call)
ProcessIncomingInviteHeaders(IEnumerable<SignalingHeader>)	Check the interesting headers for the call and initialize the needed call properties.
RaiseEvent<TEventArg>(EventHandler<TEventArg>, Object, TEventArg)	Raises a generic event with a specific event argument type to the application (Inherited from Call)
SendProvisionalResponse(Int32, CallProvisionalResponseOptions)	Sends a provisional response synchronously with optional support for early media.
UnbindMediaProvider()	Removes the currently bound media provider. BindMediaProvider(MediaProvider) (Inherited from Call)

Events

AudioVideoFlowConfigurationRequested	Raised when AudioVideoFlow is created. Applications can use this event handler to register for flow related event handlers and optionally set flow configuration.
CallMessageReceived	Raised when a SIP message is received in this call.
ConversationChanged	Raised when this call is moved to a derived conversation. (Inherited from Call)
Forwarded	Raised when the call is forwarded.
InfoReceived	Obsolete. Raised when an INFO message is received on this call. (Inherited from Call)
MediaTroubleshootingDataReported	Raised when the current call has media troubleshooting data to be reported to the application.
ProvisionalResponseReceived	Raised when a provisional response is received for an outgoing INVITE. (Inherited from Call)
RemoteParticipantChanged	Raised when the remote participant that accepted this call cannot be verified as matching the original participant invited. (Inherited from Call)
RouteSetStatusChanged	Raised when the state of the route set of the call changes. (Inherited from Call)
StateChanged	Raised when the state of the call changes. (Inherited from Call)
TransferReceived	Raised when the current call is transferred.
TransferStateChanged	Raised when the state of the transfer changes as notified by the remote participant.

Extension Methods

GetRemoteParticipant(Call)
CreateSessionErrorReport(Call, DiagnosticsInformation)
GeneratePrimarySessionCallId(Call)
GetConferenceQoeServerAddress(Call)
GetIfCallFromVerifiedSource(Call)
GetMcuReplacesInformation(Call)
Redeliver(Call)
SetMissedCallStatus(Call, Boolean)

Applies to

Share via