Start Listen Session

MUTATIONstartListenSession(quality: StreamQuality!, streamRef: ID!): StartListenSessionPayload!

Access: Public: no sign-in required.

Arguments

quality?StreamQuality!

DefaultSTANDARD

Value inHDLOWSTANDARD

streamRef*ID!

Returns

startListenSession

expiresAt?DateTime

DateTime custom scalar type that expects an ISO 8601 string

gated*Boolean!

listenUrl*String!

quality*StreamQuality!

Value inHDLOWSTANDARD

token?String

Example Request

mutation StartListenSession($streamRef: ID!) {
  startListenSession(streamRef: $streamRef) {
    expiresAt
    gated
    listenUrl
    quality
    token
  }
}

mutation StartListenSession($streamRef: ID!) {  startListenSession(streamRef: $streamRef) {    expiresAt    gated    listenUrl    quality    token  }}

Variables

{
  "streamRef": "1"
}

Variables

{  "streamRef": "1"}

Example Response

{
  "data": {
    "startListenSession": {
      "expiresAt": "<DateTime>",
      "gated": true,
      "listenUrl": "string",
      "quality": "HD",
      "token": "string"
    }
  }
}

Example Response

{  "data": {    "startListenSession": {      "expiresAt": "<DateTime>",      "gated": true,      "listenUrl": "string",      "quality": "HD",      "token": "string"    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns