Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

REST-method

Example of REST query

Example of REST response

Response statuses

/stream/terminate

Code Block
languagejs
themeRDark
{
    "mediaSessionId" : "41c3f621-a847-4639",
}

200 - Stream termination request is received

404 - Stream not found

...

/192.168.1.2:50159/192.168.1.5:8080

Parameter name

Description

Example

sessionId

Unique client session identifier

mediaSessionId

Media session identifier

41c3f621-a847-4639

name

Stream name

streamName

published

If true, the stream is published; if false, the stream is played

true

status

Current status of the stream

PUBLISHING

Stream filtering by parameters

A /stream/terminate query parameters considered as filters, all the steams that conforms to those fliters will be stopped. For example, we can stop all subscribers for all the streams published

Code Block
languagejs
themeRDark
{"published": false}

or all subsribers for certain stream

Code Block
languagejs
themeRDark
{"name": "streamName","published": false}

Streams published can be stopped by status

Code Block
languagejs
themeRDark
{"status": "PUBLISHING"}

Also all streams in certain mediasessions can be stopped

Code Block
languagejs
themeRDark
{"mediaSessionIds":["41c3f621-a847-4639", "554916e0-931c-2479"]}

The query without parameters will stop all the streams on server

Code Block
languagejs
themeRDark
{}

Sending the REST query to the WCS server

...