ms:rtc:saas:audioVideo

JSON

Represents the audio/video modality in the corresponding ms:rtc:saas:conversation.

Web link

For more on web links, see Web Links.

Name	Description
rel	The resource that this link points to. In JSON, this is the outer container.
href	The location of this resource on the server, and the target of an HTTP operation.

Resource description

In this version of the API, establishing audio/video calls is not supported.

Properties

Name	Description
callContext	Gets the call context.
state	The state of the modality, such as Connecting, Connected, or Disconnected.
supportsReplaces	Whether the replaces is supported by the remote participant.
videoSourcesAllowed	The video sources allowed to contribute to the gallery (VideoSourcesAllowed).

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:addAudio	Represents an operation to add audio to an existing conversation.
ms:rtc:saas:addAudioVideo	Represents an operation to add audio/video to an existing conversation.
ms:rtc:saas:audioVideoFlow	Flow resource.
ms:rtc:saas:conversation	Represents the local participant's perspective on a multi-modal, multi-party communication.
ms:rtc:saas:stopAudioVideo	Represents an operation to stop established AudioVideo. This token indicates the user has ability to renegotiate both audio and video.
ms:rtc:saas:transfer	Represents an operation resource for transferring call. The presence of this resource indicates a pending transfer operation.

Events

updated

Resource	Priority	Sender	Reason
ms:rtc:saas:audioVideo	High	ms:rtc:saas:conversation	Indicates that the audio/video modality was updated.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=88"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=88"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:audioVideo",
            "href" : "communication/conversations/948/audioVideo"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Operations

Returns a representation of the audio/video modality in the corresponding ms:rtc:saas:conversation.

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Error	Code	Subcode
ServiceFailure	500	InvalidExchangeServerVersion
Conflict	409	AlreadyExists
Conflict	409	TooManyGroups
Conflict	409	None
Gone	410	CannotRedirect

Examples

Request

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.