Deletestreamsource

DeleteStreamSource

This call can be used to remove particular streams together with their source files, without modifying other streams. It has three allowed forms, all behaving identically:

// Either...
{
  "deletestreamsource": "streamname_here"
}
// Or...
{
  "deletestreamsource": [
    "streamname_here",
    //multiple streams may be deleted simultaneously
  ]
}
// Or...
{
  "deletestreamsource": {
    "streamname_here": {},//contents ignored
    //multiple streams may be deleted simultaneously
  }
}

This call behaves identically to the "" call, with two exceptions. It does not result in a "streams" reply but does have its own API response, and it additionally attempts to delete the source file of the deleted stream, where possible.

The source file is only deleted if there is a single unambiguous source file (e.g. not a HLS playlist or similar, which is multi-file). If the delete succeeded and there is a DTSH header file present, the DTSH header file will be attempted to be deleted as well.

The response is in the same form as the request (a plain string, array of strings, or object of strings), where the string for each stream name gives a status response on what action was taken. Currently, possible responses are:

• 0: No action taken

• 1: Source file deleted

• 2: Source file and dtsh deleted

• : Stream deleted, source remains

• : Stream and source file deleted

• : Stream, source file and dtsh deleted

The number at te beginning of the string will always be related to the meaning behind it, even in future API updates, but the rest of the string may change in the future. In addition to these guarantees, a negative number will always indicate the stream was removed from the server configuration while a positive number will always indicate the stream wasn't removed from the server configuration (e.g. it was a wildcard-based / temporary / non-configured stream).