BitmovinApiSdk\Models\StreamKey
Synopsis
class StreamKey
extends BitmovinResource
{
- // members
- public string $value;
- public StreamKeyStatus $status;
- public StreamKeyType $type;
- public string $assignedEncodingId;
- public string $assignedIngestPointId;
- // Inherited members from BitmovinResource
- public string $name;
- public string $description;
- public Carbon $createdAt;
- public Carbon $modifiedAt;
- public mixed $customData;
- // Inherited members from BitmovinResponse
- public string $id;
- // methods
- public void __construct()
- public $this value()
- // Inherited methods from BitmovinResource
- public void __construct()
- public $this name()
- public $this description()
- public $this customData()
- // Inherited methods from BitmovinResponse
- public void __construct()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Members
public
- $assignedEncodingId — string
- $assignedIngestPointId — string
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $id — string
- $modifiedAt — Carbon\Carbon
- $name — string
- $status — BitmovinApiSdk\Models\StreamKeyStatus
- $type — BitmovinApiSdk\Models\StreamKeyType
- $value — string
Methods
public
- __construct()
- value() — Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings. If this value is not provided, a unique random stream key will be generated. **Important:** This value has to be globally unique. If it is set manually, be sure to use a secure value. If the stream key value is guessed by others your live encoding can be compromised.
Inherited from BitmovinApiSdk\Models\BitmovinResource
public
- customData() — User-specific meta data. This can hold anything.
- description() — Description of the resource. Can be freely chosen by the user.
- name() — Name of the resource. Can be freely chosen by the user.