Page History

...

test1#m1?label=John+Doe

Setting or changing stream label using REST API

Since build 5.2.1635 it is possible to set a custom stream label while adding a stream to mixer with /mixer/add REST API query

{
 "uri": "mixer://mixer1",
 "remoteStreamName": "stream1",
 "streamLabel": "John Doe"
}

The label may be changed for the stream already added to the mixer by /mixer/set_stream_label query

{
 "uri":"mixer://m1",
 "remoteStreamName":"stream1",
 "streamLabel": "Mr. John Doe"
}

or

{
 "uri":"mixer://m1",
 "remoteMediaSessionId":"95bf2be8-f459-4f62-9a7f-c588f33e0ad3",
 "streamLabel": "Mr. John Doe"
}

The label may be cleared by passing an empty string as streamLabel 

{
 "uri":"mixer://m1",
 "remoteMediaSessionId":"95bf2be8-f459-4f62-9a7f-c588f33e0ad3",
 "streamLabel": ""
}

In this case the stream name will be displayed as published.

Caption location

Obsoleted settings in builds from 5.2.844 to 5.2.1077

...