Create a free ticket and our support team will provide you necessary assistance.
Full create stream request. | ||||
---|---|---|---|---|
Request type | POST | |||
URL | https://api.stormstreaming.com/api/request/stream | |||
Headers |
|
Request body. | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description | ||||||||||||||||||||
name | - | yes | String 1-255 characters. | Stream name. | ||||||||||||||||||||
description | - | no | String 1-2000 characters. | Stream description. | ||||||||||||||||||||
regionId | - | yes | Int value from description table on the right. |
Defined region should be located as close as possible to the stream source.
|
||||||||||||||||||||
countdown | 0 | no | Int 0/1 | Determines whether a countdown clock will be displayed before the stream is published. | ||||||||||||||||||||
countdownStartDate | - | Required if the 'countdown' field is set to '1' or 'true'. | d.m.Y H:i:s | The date when you plan to publish the stream. | ||||||||||||||||||||
countdownTimezone | - | Required if the 'countdown' field is set to '1' or 'true'. | The list of supported timezones is available in the 'Get Possible Values' request. | Timezone should be set to match the local time of the event and the countdown date. | ||||||||||||||||||||
isPublished | 1 | no | Int 0/1 |
Decides if stream is published.
The maximum number of simultaneously published streams defines your
subscription plan. 0 – not published 1 - published |
||||||||||||||||||||
sourceType | PUSH | no | String PUSH/PULL |
PUSH – if you plan to push new stream using popular encoders like OBS,
XSplit, Streamlabs. PULL – if you plan to pull existing stream from another streaming server. |
||||||||||||||||||||
sourceId | - | Required if sourceType is set to 'PULL'. | Int value from source list row. | You can define a list of sources at https://cloud.stormstreaming.com/stream-sources. | ||||||||||||||||||||
encoderMode | PASSTHROUGH | no | String PASSTHROUGH/ ABR |
Defines encoder behaviour. PASSTHROUGH - all viewers will receive the same version of the stream that you provide us with. The encoder is not used here. ABR – Adaptive Bitrate - a single viewer receives a version of the stream adapted to the capabilities of his device and internet. The encoder itself will select the parameters and the number of subversions of your stream. |
||||||||||||||||||||
themeId | - | no | The list of supported themes is available in the 'Get Possible Values' request. | You can define your custom theme at https://cloud.stormstreaming.com/settings/themes. | ||||||||||||||||||||
thumbnailFile | - | no | Accepted image mimes: jpeg,png,jpg,gif,webp. Max file size: 8192KB. | The thumbnail will be displayed on the list of streams in the Storm Cloud platform. | ||||||||||||||||||||
splashscreenFile | - | no | Accepted image mimes: jpeg,png,jpg,gif,webp. Max file size: 8192KB. | The splashscreen (waiting room image) will be displayed as a background behind the countdown timer. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to Update the Basic Info Section. | ||||
---|---|---|---|---|
Request type | PUT | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/basic-info | |||
Headers |
|
|||
URL params |
|
Request body. | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description | ||||||||||||||||||||
name | - | yes | String 1-255 characters. | Stream name. | ||||||||||||||||||||
description | - | no | String 1-2000 characters. | Stream description. | ||||||||||||||||||||
regionId | - | yes | Integer value from the description table to the right. The list is also accessible through the 'Get Possible Values' request. |
Defined region should be located as close as possible to the stream source.
|
||||||||||||||||||||
countdown | 0 | no | Int 0/1 | Determines whether a countdown clock will be displayed before the stream is published. | ||||||||||||||||||||
countdownStartDate | - | Required if the 'countdown' field is set to '1' or 'true'. | d.m.Y H:i:s | The date when you plan to publish the stream. | ||||||||||||||||||||
countdownTimezone | - | Required if the 'countdown' field is set to '1' or 'true'. | The list of supported timezones is available in the 'Get Possible Values' request. | Timezone should be set to match the local time of the event and the countdown date. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to Update the Sources Section. | ||||
---|---|---|---|---|
Request type | PUT | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/sources | |||
Headers |
|
|||
URL params |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
sourceType | PUSH | no | String PUSH/PULL |
PUSH – if you plan to push new stream using popular encoders like OBS,
XSplit, Streamlabs. PULL – if you plan to pull existing stream from another streaming server. |
sourceId | - | Required if sourceType is set to 'PULL'. | Int value from source list row. | You can define a list of sources at https://cloud.stormstreaming.com/stream-sources. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to Update the Encoder Section. | ||||
---|---|---|---|---|
Request type | PUT | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/encoder | |||
Headers |
|
|||
URL params |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
encoderMode | PASSTHROUGH | no | String PASSTHROUGH / ABR |
Defines encoder behaviour. PASSTHROUGH - all viewers will receive the same version of the stream that you provide us with. The encoder is not used here. ABR – Adaptive Bitrate - a single viewer receives a version of the stream adapted to the capabilities of his device and internet. The encoder itself will select the parameters and the number of subversions of your stream. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to Update the Player Section. | ||||
---|---|---|---|---|
Request type | PUT | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/player | |||
Headers |
|
|||
URL params |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
themeId | - | no | Int value from themes list row. | You can define a list of sources at https://cloud.stormstreaming.com/settings/themes. |
Response | |
---|---|
Code | 200 |
Body |
|
A request to update the thumbnail image of the stream. | ||||
---|---|---|---|---|
Request type | POST | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/set-thumbnail | |||
Headers |
|
|||
URL params |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
thumbnailFile | - | no | Accepted image mimes: jpeg,png,jpg,gif,webp. Max file size: 8192KB. | The thumbnail will be displayed on the list of streams in the Storm Cloud platform. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to update the splashcreen (countdown background image) image of the stream. | ||||
---|---|---|---|---|
Request type | POST | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/set-splashscreen | |||
Headers |
|
|||
URL params |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
splashscreenFile | - | no | Accepted image mimes: jpeg,png,jpg,gif,webp. Max file size: 8192KB. | The splashscreen (waiting room image) will be displayed as a background behind the countdown timer. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to set publish status of the stream. | ||||
---|---|---|---|---|
Request type | PATCH | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key>/set-published | |||
Headers |
|
|||
URL params |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
isPublished | 1 | no | Int 0/1 |
Decides if stream is published.
The maximum number of simultaneously published streams defines your
subscription plan. 0 – not published 1 - published |
Response | |
---|---|
Code | 200 |
Body |
|
Request to delete stream. | ||||
---|---|---|---|---|
Request type | DELETE | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key> | |||
Headers |
|
|||
URL params |
|
Response | |
---|---|
Code | 200 |
Body |
|
Request for Retrieving the List of Possible Values for regionId and countdownTimezone. | ||||
---|---|---|---|---|
Request type | GET | |||
URL | https://api.stormstreaming.com/api/request/stream/create-possible-values | |||
Headers |
|
Request body. | ||||
---|---|---|---|---|
Field name | Type | Description | ||
timezones | String[] | Specifies the allowable values for the 'timezone' field during the creation of a stream or when updating basic information. | ||
regions | Object[] | Specifies the allowable values for the 'regionId' field during the creation of a stream or when updating basic information. | ||
isTranscodingEnabled | Boolean | Determines if transcoding functionality is enabled in your subscription plan. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to fetch stream list. | ||||
---|---|---|---|---|
Request type | GET | |||
URL | https://api.stormstreaming.com/api/request/stream/list | |||
Headers |
|
Request body. | ||||
---|---|---|---|---|
Field | Default value | Is required | Validation rules | Description |
query | - | no | String 1-255 characters. | Flexible search field. Smart and typo-tolerant phrase matching. |
page | 1 | no | Int | Current list page. |
rowsPerPage | 10 | no | Int 5-50 | Maximum rows per page. |
order | desc | no | String asc/desc | Defines the order of results: 'desc' for the newest first, 'asc' for the oldest first. |
orderBy | createDate | no | String createDate/streamName/isPublished | Defines the column you want to sort by. |
Response parameters. | ||||
---|---|---|---|---|
Field name | Type | Description | ||
streamKey | String 40 characters. | Stream unique key. | ||
name | String 1-255 characters. | Stream name. | ||
thumbUrl | String 1-255 characters. Can be null. | The URL of the thumbnail image, which visually represents the stream's content, uploaded at the time of the stream's creation. | ||
isPublished | Boolean | A boolean field indicating whether the stream is currently live and viewable by the audience. | ||
createDate | String[] Y-m-d\TH:i:s.u\Z GMT +1 | The date and time when the stream was created in the system. | ||
highlight | String 1-350 characters. Can be null. | This column designates specific search terms within a string by enclosing them in <highlight> tags, thus emphasizing the words that match the search query. It's utilized to visually differentiate the searched terms from the rest of the text. |
Response | |
---|---|
Code | 200 |
Body |
|
Request to fetch stream list. | ||||
---|---|---|---|---|
This request is cached for 60 seconds. | ||||
Request type | GET | |||
URL | https://api.stormstreaming.com/api/request/stream/<stream key> | |||
Headers |
|
|||
URL params |
|
Response parameters. | ||||
---|---|---|---|---|
Field name | Type | Description | ||
streamKey | String 40 characters. | Stream unique key. | ||
name | String 1-255 characters. | Stream name. | ||
description | String 1-2000 characters. Can be null. | Stream description. | ||
regionId | Int | Denotes the regional source from which the stream originates. | ||
isPublished | Boolean | A boolean field indicating whether the stream is currently live and viewable by the audience. | ||
countdown | Object. Can be null. | Information about stream countdown. | ||
countdown.isCountdown | Boolean | Indicates whether the stream features an active countdown timer. | ||
countdown.startDate | String Y-m-d\TH:i:s.u\Z | A designated start date for the stream. | ||
countdown.timezone | String 1-50 characters. | The timezone associated with the countdown timer's start date. | ||
encoderMode | String ABR/PASSTHROUGH | Defines encoder mode. | ||
credentials | Object | Credentials required to publish a stream to the Storm Cloud. Example, OBS authorization details can be found here: https://stormstreaming.com/docs/v2/cloud-tutorials-obs-connection-authentication. | ||
credentials.username | String 1-10 characters. | Username for authorization. | ||
credentials.password | String 1-20 characters. | Password for authorization. | ||
thumbnail | Object[]. Can be null. | Information about the thumbnail image set during stream creation. The thumbnail is utilized in Storm Cloud lists. | ||
thumbnail[].sizeName | String 1-30 characters. | Size name of thumbnail image. | ||
thumbnail[].width | Int | Width of thumbnail image. | ||
thumbnail[].height | Int | Height of thumbnail image. | ||
splashscreen | Object[]. Can be null. | Details regarding the splash screen image set during stream creation. The splash screen serves as the background in the player during countdown. | ||
splashscreen[].sizeName | String 1-30 characters. | Size name of splashscreen image. | ||
splashscreen[].width | Int | Width of splashscreen image. | ||
splashscreen[].height | Int | Height of splashscreen image. | ||
sourceType | String PUSH/PULL | Defines if stream is PUSHED or PULLED from other streaming server. | ||
source | Object. Can be null. | The source information of the stream when the 'sourceType' field is set to 'PULL'. | ||
source.id | Int | Source identifier. | ||
source.name | String 1-255 characters. | Source name. | ||
source.protocol | String RTMP/RTSP/SRT | Source protocol. | ||
source.url | String 1-255 characters. | The source URL from which Storm will fetch the stream. | ||
source.isAuth | Boolean | Determines whether authorization is required for fetching the stream. | ||
source.authUsername | String 1-100 characters. | Source authorization username. | ||
source.authPassword | String 1-100 characters. | Source authorization password. | ||
source.isCreated | Boolean | Determines if the source creation process is complete and ready for use. | ||
source.createdAt | String Y-m-d\TH:i:s.u\Z | Source create date. | ||
targets | Object[] | Specifies the target destinations to which the stream will be forwarded. | ||
targets[].name | String 1-255 characters. | Target name. | ||
targets[].restreamType | String 1-30. | The restream type of the target, for example, 'Facebook'. | ||
targets[].url | String 1-255 characters. | The target URL to which Storm will push the stream. | ||
targets[].isAuth | Boolean | Determines whether authorization is required for push. | ||
targets[].authUsername | String 1-100 characters. | Target authorization username. | ||
targets[].authPassword | String 1-100 characters. | Target authorization password. | ||
targets[].isCreated | Boolean | Determines if the target creation process is complete and ready for use. | ||
targets[].createdAt | String Y-m-d\TH:i:s.u\Z | Target create date. | ||
themeId | Int. Can be null | Chosen theme identifier. | ||
theme | Object | Information about the player's theme. | ||
theme.id | Int | Theme identifier. | ||
theme.name | String 1-255 characters. | Theme name. | ||
theme.isDefault | Boolean | Determines if the theme is used as the default when no theme is set for the stream. | ||
theme.theme | Object | Theme settings. | ||
theme.logo | Object. Can be null. | The logo that will be displayed on the player. | ||
theme.logo.id | Int | Logo id. | ||
theme.logo.path | String 1-255 characters. | Logo path. | ||
theme.createdAt | String Y-m-d\TH:i:s.u\Z | Theme create date. | ||
theme.updatedAt | String Y-m-d\TH:i:s.u\Z | Theme last update date. | ||
isCreated | Boolean | Determines if the stream is finalized and ready for use. | ||
createdAt | String Y-m-d\TH:i:s.u\Z | Stream create date. |
Response | |
---|---|
Code | 200 |
Body |
|
Create a free ticket and our support team will provide you necessary assistance.