Storm Streaming Server operates based on what are called "applications," which are collections of streams and the settings that govern them. Each server instance can have multiple applications, which are completely independent of each other. Each application has its unique name and type, which defines its role. Among the things that an application allows you to define are for example: the method of authentication for incoming streams, whether streams should be recorded, or whether you want to use transcoding to create multiple quality versions.
The basic type of application is called "live", which within a single server instance allows for both publishing and playing back streams. There are also other applications like "origin" and "edge", which are used in building clusters consisting of multiple server instances. You can learn more about these here in our Scaling & Cluster Guide.
This type of applications is the simplest one and are best suited for single instance configuration.
<Application name="live" type="live">
<RTMPController>
<AllowStreamPublish>true</AllowStreamPublish>
<AllowStreamOverwrite>true</AllowStreamOverwrite>
<AllowClientPlayback>true</AllowClientPlayback>
<AutoPublishStream>true</AutoPublishStream>
<KeepClientStreamsAlive>true</KeepClientStreamsAlive>
<PlaybackAuthRequired>false</PlaybackAuthRequired>
<Authorization enabled="false"></Authorization>
</RTMPController>
<SecureStream enabled="false">
<Password>qwerty</Password>
<CheckViewerIP>true</CheckViewerIP>
<TokenLifespan>10</TokenLifespan>
</SecureStream>
<MP4MuxerSettings>
<VariableFPS>true</VariableFPS>
<KeyFrameCompensation>false</KeyFrameCompensation>
</MP4MuxerSettings>
<DVRSettings enabled="false">
<CacheSize>100</CacheSize>
</DVRSettings>
<RecordingSettings enabled="false">
<SavePath>/Users/Johny/Desktop</SavePath>
<CacheSize>15</CacheSize>
<MaxFileSize>15</MaxFileSize>
<MaxFileDuration>0</MaxFileDuration>
<MaxStorageSize>0</MaxStorageSize>
<RemoveOldFiles>true</RemoveOldFiles>
</RecordingSettings>
<TranscoderSettings enabled="true">
<Preset name="720p" />
<Preset name="360p" />
</TranscoderSettings>
</Application>
| Application:name | Name of this application. If there are more applications within your preferences.xml they all must have unique names. The default one is called “live”. |
| Application:type | This value must be set to “live” for this type of Application. Other types are “origin” and “edge” and you can learn more about them here. |
This block of settings specifies the exact behavior for RTMP-based connections.
| AllowStreamPublish | Defines whenever publishing (using for example OBS) to this application is allowed or not. |
| AllowStreamOverwrite | If this option is set to true a stream can be overwritten by another one with the same name. |
| AllowClientPlayback | Defines whenever playback from this application is possible for RTMP connections. |
| AutoPublishStream | If set to false, an incoming (ingest) stream will not be published automatically upon its creation. This means it cannot be viewed by viewers unless it is set to **published** manually (using the Control Panel or RESTful API). |
| KeepClientStreamsAlive | If this option is set to false, any RTMP created though pull mechanism (external RTMP server) will be closed if number of viewer drops to zero and remain at that level for 30 seconds. |
| PlaybackAuthRequired | If this option is set to true all RTMP clients must authorize for playback using either a token or credentials. |
To enable authorization for Publish or Playback Authorization block must be configured:
| Authorization:enable | If true authentication is enabled and required (by default only for publishing). If you wish to authenticate client (playback) connection PlaybackAuthRequired must be set to true. |
| sourceType | Possible values: local – you can define auth items within Authorization tag in the following manner. One item is of credentials type (username & password), the other is a token: <Authorization enabled="true" sourceType="local"> <auth username="admin" password="qwerty" /> <auth token="62cjdj" expire="2022-02-01 16:22:00" /> </Authorization> global – application will use global pool of users and tokens for authorization. This pool is defined in <StreamAuthorization> tag. request – server will perform a request to an URL specified in parameter sourceTarget with added streamKey at the end: <Authorization enabled="true" sourceType="request" sourceTarget="localhost/api/auth"></Authorization> (for a stream called “test”, request will take a form of "localhost/api/auth/test") A response should looks as follow: { "status":"success", "data":[ { "steamKey":"test" "username":"admin", "password":"qwerty" }, ] } |
| sourceTarget | An URL where request should be made for auth items (only for sourceType:request). |
SecureStream allows to protect stream playback using a special token. Can will change depending on viewer’s IP (optionally) or time. If you wish to learn more about this function, check our guide for SecureStream.
| SecureStream:enable | Defines whenever SecureStream is enabled for this application or not. |
| Password | Unique password that will be used for creating a token. |
| CheckViewerIP | Defines whenever viewer’s IP should be used to create a token. |
| TokenLifespan | Defines token’s lifespan (in minutes). |
MP4MuxerSettings block defines basic options for MP4 packager that is used for MSE/HLS connections.
| VariableFPS | If the source stream has no const frame rate (e.g. WebRTC-based source) muxer will try to fix the stream by adjusting composition times for selected frames. |
| KeyFrameCompensation | Enables mechanism where “empty” frames are inserted into a stream if Audio/Video desynchronization is detected. |
DVR function allows for short live-stream rewind mechanism based on cached stream.
| DVRSettings:enabled | Defines whenever DVR is enabled. |
| CacheSize | Number of MB within memory for storing video stream. Length of stored video material will depend on resolution and bitrate |
Recording option allows for recording video streams into MP4 files.
| RecordingSettings:enabled | Defines whenever recording is enabled. |
| SavePath | Path were MP4 files should be saved. |
| CacheSize | Defines how much of a video stream should be kept in memory before being flushed to a file. |
| MaxFileSize | Maximum video file size. If a stream reaches this size, it will be split into additional files. This parameter is optional, and if not present or set to zero, no limit will be in effect. |
| MaxFileDuration | Maximum video file duration (time). If a stream exceeds this duration, it will be split into multiple files. This parameter is optional, and if not specified or set to zero, there will be no limit in effect. |
| MaxStorageSize | Storm will calculate sum of all saved video files in particular folder and either stop saving new ones, or it'll start overwriting older files if RemoveOldFiles is set to true. This parameter is optional and if not present or set to 0 no limitation will be added. |
| RemoveOldFiles | If set to true and combined with MaxStorageSize, older video files will be removed to make space for new ones. |
For each individual application a set of presets for transcoding can be selected. Please keep in mind that presets must be already defined in your preferences.xml file. If you would like to define your own presets and learn more about transcoding check our Transcoding Guide.
| TranscoderSettings:enabled | If set to false, no video stream will be transcoded. |
| preset:name | Name of a template, previously defined in main Transcoder tag. |
Create a free ticket and our support team will provide you necessary assistance.