End Live Session

MUTATIONendLiveSession(input: EndLiveSessionInput!): LiveSessionMutationOutput!

Access: Requires the streams:write permission. Requires the cloud station add-on.

Arguments

input*

Returns

endLiveSession

message?String

session?

success*Boolean!

Example Request

mutation EndLiveSession($input: EndLiveSessionInput!) {
  endLiveSession(input: $input) {
    message
    session {
      createdAt
      endedAt
      generation
      id
      queue {
        createdAt
        id
        position
        shortId
        status
      }
      shortId
      skipNonce
      startedAt
      startedByUserId
      stream {
        activeListeners
        config
        createdAt
        desiredState
        enabled
        hdEnabled
        id
        listenerAccess
      }
    }
    success
  }
}

mutation EndLiveSession($input: EndLiveSessionInput!) {  endLiveSession(input: $input) {    message    session {      createdAt      endedAt      generation      id      queue {        createdAt        id        position        shortId        status      }      shortId      skipNonce      startedAt      startedByUserId      stream {        activeListeners        config        createdAt        desiredState        enabled        hdEnabled        id        listenerAccess      }    }    success  }}

Variables

{
  "input": {
    "sessionId": "1"
  }
}

Variables

{  "input": {    "sessionId": "1"  }}

Example Response

{
  "data": {
    "endLiveSession": {
      "message": "string",
      "session": {
        "createdAt": "<DateTime>",
        "endedAt": "<DateTime>",
        "generation": 10,
        "id": "1",
        "queue": [
          {
            "createdAt": "<DateTime>",
            "id": "1",
            "position": 10,
            "shortId": "string",
            "status": "PENDING"
          }
        ],
        "shortId": "string",
        "skipNonce": 10,
        "startedAt": "<DateTime>",
        "startedByUserId": "string",
        "stream": {
          "activeListeners": 10,
          "config": "<JSON>",
          "createdAt": "<DateTime>",
          "desiredState": "ACTIVE",
          "enabled": true,
          "hdEnabled": true,
          "id": "1",
          "listenerAccess": "FREE"
        }
      },
      "success": true
    }
  }
}

Example Response

{  "data": {    "endLiveSession": {      "message": "string",      "session": {        "createdAt": "<DateTime>",        "endedAt": "<DateTime>",        "generation": 10,        "id": "1",        "queue": [          {            "createdAt": "<DateTime>",            "id": "1",            "position": 10,            "shortId": "string",            "status": "PENDING"          }        ],        "shortId": "string",        "skipNonce": 10,        "startedAt": "<DateTime>",        "startedByUserId": "string",        "stream": {          "activeListeners": 10,          "config": "<JSON>",          "createdAt": "<DateTime>",          "desiredState": "ACTIVE",          "enabled": true,          "hdEnabled": true,          "id": "1",          "listenerAccess": "FREE"        }      },      "success": true    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns