Rate this page:

StreamingAgentSettings

Add the following line to your scenario code to use the interface:

require(Modules.StreamingAgent);

Props

applicationName

Copy URL
applicationName: 

string

|

undefined

Part of streamName, e.g, live2. The parameter is platform dependent, use it if it is required by the streaming platform.

backupUrl

Copy URL
backupUrl: 

string

|

undefined

URL of another streaming server which is used if the server specified in url does not respond.

keyframeInterval

Copy URL
keyframeInterval: 

number

|

undefined

How often a keyframe in a stream is created (seconds). Default value is 2. Any value less than "2" yields "2".

protocol

Copy URL
protocol: 

RTMP

Protocol for streaming purposes. Currently only RTMP is supported.

streamName

Copy URL
streamName: 

string

|

undefined

Unique stream name, should be used along with url. Can be retrieved from a live-streaming CDN provider.

url

Copy URL
url: 

string

URL of a server which processes video streaming. Can be retrieved from a live-streaming CDN provider.