POST api/OpenviduApi/Session

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
MediaMode	string	None.
RecordingMode	string	None.
CustomSessionId	string	None.
ForcedVideoCodec	string	None.
AllowTranscoding	boolean	None.
DefaultRecordingProperties	DefaultRecordingProperties	None.
MediaNode	MediaNode	None.

Request Formats

application/json, text/json

Sample:

{
  "MediaMode": "sample string 1",
  "RecordingMode": "sample string 2",
  "CustomSessionId": "sample string 3",
  "ForcedVideoCodec": "sample string 4",
  "AllowTranscoding": true,
  "DefaultRecordingProperties": {
    "Name": "sample string 1",
    "HasAudio": true,
    "HasVideo": true,
    "OutputMode": "sample string 4",
    "RecordingLayout": "sample string 5",
    "Resolution": "sample string 6",
    "FrameRate": 7,
    "ShmSize": 8,
    "MediaNode": "sample string 9"
  },
  "MediaNode": {
    "Id": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<SessionInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Communicator.Models.Openvidu">
  <AllowTranscoding>true</AllowTranscoding>
  <CustomSessionId>sample string 3</CustomSessionId>
  <DefaultRecordingProperties>
    <FrameRate>7</FrameRate>
    <HasAudio>true</HasAudio>
    <HasVideo>true</HasVideo>
    <MediaNode>sample string 9</MediaNode>
    <Name>sample string 1</Name>
    <OutputMode>sample string 4</OutputMode>
    <RecordingLayout>sample string 5</RecordingLayout>
    <Resolution>sample string 6</Resolution>
    <ShmSize>8</ShmSize>
  </DefaultRecordingProperties>
  <ForcedVideoCodec>sample string 4</ForcedVideoCodec>
  <MediaMode>sample string 1</MediaMode>
  <MediaNode>
    <Id>sample string 1</Id>
  </MediaNode>
  <RecordingMode>sample string 2</RecordingMode>
</SessionInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JsonResultOfCommunicatorJsonResult

Name	Type	Additional information
Content	CommunicatorJsonResult	None.
SerializerSettings	JsonSerializerSettings	None.
Encoding	Encoding	None.
Request	HttpRequestMessage	None.

Response Formats

application/json, text/json

Sample:

Sample not available.