Versions Compared

Key

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

...

REST queries and responses

REST query

REST query body example

REST response example

Response states

Description

/stream/inject/startup

Code Block
languagejs
themeRDark
{
 "localStreamName": "stream1",
 "remoteStreamName": "stream2"
}

200 - OK

400 - Bad request

404 - Not found

409 - Conflict

500 - Internal error


Inject stream2 into stream1


/stream/inject/find_all
Code Block
languagejs
themeRDark
[
 {
   "localStreamName": "stream1",
   "remoteStreamName": "stream2"
 }
]

200 - OK

404 - Not found


Find all injections on the server
/stream/inject/terminate
Code Block
languagejs
themeRDark
{
 "localStreamName": "stream1"
}

200 - OK

400 - Bad request

404 - Not found

500 - Internal error


Stop injection into stream1

Parameters

Name

Description

Example

localStreamNameStream name to inject to
stream1
remoteStreamNameStream name to be injected
stream2

Configuration

Since build 5.2.1235 the parameter is added to set a time interval to wait for a keyframe in injected stream

Code Block
themeRDark
inject_wait_keyframe_ms=1000

By default, the interval is 1000 milliseconds. If no keyframes arrived in injected stream during this time, server will generate a black picture (by default) or apicture from a file set by  custom_watermark_filename parameter. This behaviour may be switched off by the following parameter

Code Block
themeRDark
inject_wait_keyframe_ms=-1

In this case, the stream to be injected to will be played until keyframe arrives in the injected stream.

Quick testing

1. For test we use

...