From 323504ac0b9cfa57e1eb98a13b76c60df3d80d3e Mon Sep 17 00:00:00 2001 From: Bitmovin OpenApi Bot Date: Tue, 30 Jan 2024 16:34:56 +0000 Subject: [PATCH] Updated PHP client to v1.184.1 --- README.md | 4 +- composer.json | 2 +- docs/classes.html | 128 +++++++++++++ ...movinApiSdk_Apis_Encoding_EncodingApi.html | 4 + ...ovinApiSdk_Apis_Encoding_Live_LiveApi.html | 83 ++++++++ .../__construct.html | 90 +++++++++ ...e_StreamKeys_StreamKeyListQueryParams.html | 128 +++++++++++++ .../assignedEncodingId.html | 93 +++++++++ .../assignedIngestPointId.html | 93 +++++++++ .../create.html | 82 ++++++++ .../limit.html | 93 +++++++++ .../offset.html | 93 +++++++++ .../sort.html | 93 +++++++++ .../status.html | 93 +++++++++ .../toArray.html | 81 ++++++++ .../type.html | 93 +++++++++ ...treamKeys_StreamKeyPaginationResponse.html | 155 +++++++++++++++ .../__construct.html | 83 ++++++++ ...ncoding_Live_StreamKeys_StreamKeysApi.html | 93 +++++++++ .../__construct.html | 90 +++++++++ .../create.html | 105 +++++++++++ .../delete.html | 105 +++++++++++ .../get.html | 105 +++++++++++ .../list.html | 105 +++++++++++ ...movinApiSdk_Models_RedundantRtmpInput.html | 10 +- .../ingestPoints.html | 2 +- .../staticIngestPoints.html | 94 +++++++++ ...inApiSdk_Models_StaticRtmpIngestPoint.html | 137 ++++++++++++++ .../__construct.html | 83 ++++++++ .../id.html | 94 +++++++++ .../name.html | 94 +++++++++ .../streamKeyConfiguration.html | 94 +++++++++ .../BitmovinApiSdk_Models_StreamKey.html | 178 ++++++++++++++++++ .../__construct.html | 83 ++++++++ .../value.html | 94 +++++++++ ...nApiSdk_Models_StreamKeyConfiguration.html | 130 +++++++++++++ .../__construct.html | 83 ++++++++ .../streamKeyId.html | 94 +++++++++ .../type.html | 94 +++++++++ ...Sdk_Models_StreamKeyConfigurationType.html | 141 ++++++++++++++ .../ASSIGN.html | 82 ++++++++ .../GENERATE.html | 82 ++++++++ .../create.html | 93 +++++++++ ...BitmovinApiSdk_Models_StreamKeyStatus.html | 141 ++++++++++++++ .../ASSIGNED.html | 82 ++++++++ .../UNASSIGNED.html | 82 ++++++++ .../create.html | 93 +++++++++ .../BitmovinApiSdk_Models_StreamKeyType.html | 141 ++++++++++++++ .../RESERVED.html | 82 ++++++++ .../TEMPORARY.html | 82 ++++++++ .../create.html | 93 +++++++++ docs/index.html | 2 +- docs/namespaces.html | 18 +- src/Apis/Encoding/EncodingApi.php | 5 + src/Apis/Encoding/Live/LiveApi.php | 33 ++++ .../StreamKeys/StreamKeyListQueryParams.php | 132 +++++++++++++ .../StreamKeyPaginationResponse.php | 19 ++ .../Live/StreamKeys/StreamKeysApi.php | 91 +++++++++ src/Common/Middleware/CustomApiHeaders.php | 2 +- src/Models/RedundantRtmpInput.php | 19 +- src/Models/StaticRtmpIngestPoint.php | 64 +++++++ src/Models/StreamKey.php | 45 +++++ src/Models/StreamKeyConfiguration.php | 48 +++++ src/Models/StreamKeyConfigurationType.php | 42 +++++ src/Models/StreamKeyStatus.php | 42 +++++ src/Models/StreamKeyType.php | 42 +++++ 66 files changed, 5247 insertions(+), 9 deletions(-) create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi/__construct.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedEncodingId.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedIngestPointId.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/create.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/limit.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/offset.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/sort.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/status.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/toArray.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/type.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse/__construct.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/__construct.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/create.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/delete.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/get.html create mode 100644 docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/list.html create mode 100644 docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/staticIngestPoints.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/__construct.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/id.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/name.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/streamKeyConfiguration.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKey.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKey/__construct.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKey/value.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/__construct.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/streamKeyId.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/type.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/ASSIGN.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/GENERATE.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/create.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyStatus.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/ASSIGNED.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/UNASSIGNED.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/create.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyType.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyType/RESERVED.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyType/TEMPORARY.html create mode 100644 docs/classes/BitmovinApiSdk_Models_StreamKeyType/create.html create mode 100644 src/Apis/Encoding/Live/LiveApi.php create mode 100644 src/Apis/Encoding/Live/StreamKeys/StreamKeyListQueryParams.php create mode 100644 src/Apis/Encoding/Live/StreamKeys/StreamKeyPaginationResponse.php create mode 100644 src/Apis/Encoding/Live/StreamKeys/StreamKeysApi.php create mode 100644 src/Models/StaticRtmpIngestPoint.php create mode 100644 src/Models/StreamKey.php create mode 100644 src/Models/StreamKeyConfiguration.php create mode 100644 src/Models/StreamKeyConfigurationType.php create mode 100644 src/Models/StreamKeyStatus.php create mode 100644 src/Models/StreamKeyType.php diff --git a/README.md b/README.md index c78990ce8..170116637 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ To install the API client with composer, add the following to your composer.json { "require": { - "bitmovin/bitmovin-api-sdk-php": "1.183.2" + "bitmovin/bitmovin-api-sdk-php": "1.184.1" } } ``` @@ -49,7 +49,7 @@ Then run `php composer.phar install` OR -run the following command: `php composer.phar require bitmovin/bitmovin-api-sdk-php:1.183.2` +run the following command: `php composer.phar require bitmovin/bitmovin-api-sdk-php:1.184.1` ## Initialization diff --git a/composer.json b/composer.json index 50a6dcd45..1e2dadf47 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "bitmovin/bitmovin-api-sdk-php", "description": "This is the Bitmovin API SDK for PHP", - "version": "1.183.2", + "version": "1.184.1", "authors": [ { "name": "Bitmovin Inc", diff --git a/docs/classes.html b/docs/classes.html index 5d4422d70..6b7e2153d 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -12133,6 +12133,74 @@

\BitmovinApiSdk\Api +
+

\BitmovinApiSdk\Apis\Encoding\Live

+ + + + + + + + + + + + + + +
NameDescription +
+ LiveApi + + No description available + EMPTY +
+
+
+

\BitmovinApiSdk\Apis\Encoding\Live\StreamKeys

+ + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription +
+ StreamKeyListQueryParams + + No description available + EMPTY +
+ StreamKeyPaginationResponse + + No description available + EMPTY +
+ StreamKeysApi + + No description available + EMPTY +
+

\BitmovinApiSdk\Apis\Encoding\Manifests

@@ -24428,6 +24496,16 @@

\BitmovinApiSdk\Models

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4129,7 +4145,7 @@

Namespaces

diff --git a/src/Apis/Encoding/EncodingApi.php b/src/Apis/Encoding/EncodingApi.php index 4cdbc20c3..ec3583d80 100644 --- a/src/Apis/Encoding/EncodingApi.php +++ b/src/Apis/Encoding/EncodingApi.php @@ -13,6 +13,7 @@ use BitmovinApiSdk\Apis\Encoding\Configurations\ConfigurationsApi; use BitmovinApiSdk\Apis\Encoding\Filters\FiltersApi; use BitmovinApiSdk\Apis\Encoding\Encodings\EncodingsApi; +use BitmovinApiSdk\Apis\Encoding\Live\LiveApi; use BitmovinApiSdk\Apis\Encoding\Manifests\ManifestsApi; use BitmovinApiSdk\Apis\Encoding\Infrastructure\InfrastructureApi; use BitmovinApiSdk\Apis\Encoding\Statistics\StatisticsApi; @@ -41,6 +42,9 @@ class EncodingApi /** @var EncodingsApi */ public $encodings; + /** @var LiveApi */ + public $live; + /** @var ManifestsApi */ public $manifests; @@ -77,6 +81,7 @@ public function __construct(Configuration $config = null, HttpWrapper $httpWrapp $this->configurations = new ConfigurationsApi(null, $this->httpWrapper); $this->filters = new FiltersApi(null, $this->httpWrapper); $this->encodings = new EncodingsApi(null, $this->httpWrapper); + $this->live = new LiveApi(null, $this->httpWrapper); $this->manifests = new ManifestsApi(null, $this->httpWrapper); $this->infrastructure = new InfrastructureApi(null, $this->httpWrapper); $this->statistics = new StatisticsApi(null, $this->httpWrapper); diff --git a/src/Apis/Encoding/Live/LiveApi.php b/src/Apis/Encoding/Live/LiveApi.php new file mode 100644 index 000000000..41a967b3e --- /dev/null +++ b/src/Apis/Encoding/Live/LiveApi.php @@ -0,0 +1,33 @@ +httpWrapper = $httpWrapper ?? new HttpWrapper($config); + + $this->streamKeys = new StreamKeysApi(null, $this->httpWrapper); + } +} diff --git a/src/Apis/Encoding/Live/StreamKeys/StreamKeyListQueryParams.php b/src/Apis/Encoding/Live/StreamKeys/StreamKeyListQueryParams.php new file mode 100644 index 000000000..0ad2f7688 --- /dev/null +++ b/src/Apis/Encoding/Live/StreamKeys/StreamKeyListQueryParams.php @@ -0,0 +1,132 @@ +offset = $offset; + + return $this; + } + + /** + * @param int $limit + * @return StreamKeyListQueryParams + */ + public function limit(int $limit): StreamKeyListQueryParams + { + $this->limit = $limit; + + return $this; + } + + /** + * @param string $sort + * @return StreamKeyListQueryParams + */ + public function sort(string $sort): StreamKeyListQueryParams + { + $this->sort = $sort; + + return $this; + } + + /** + * @param string $type + * @return StreamKeyListQueryParams + */ + public function type(string $type): StreamKeyListQueryParams + { + $this->type = $type; + + return $this; + } + + /** + * @param string $status + * @return StreamKeyListQueryParams + */ + public function status(string $status): StreamKeyListQueryParams + { + $this->status = $status; + + return $this; + } + + /** + * @param string $assignedIngestPointId + * @return StreamKeyListQueryParams + */ + public function assignedIngestPointId(string $assignedIngestPointId): StreamKeyListQueryParams + { + $this->assignedIngestPointId = $assignedIngestPointId; + + return $this; + } + + /** + * @param string $assignedEncodingId + * @return StreamKeyListQueryParams + */ + public function assignedEncodingId(string $assignedEncodingId): StreamKeyListQueryParams + { + $this->assignedEncodingId = $assignedEncodingId; + + return $this; + } + + public function toArray(): array + { + return array_map(function ($value) { + if($value instanceof Carbon) + { + return $value->utc()->toIso8601ZuluString(); + } + + if($value instanceof \JsonSerializable) + { + return $value->jsonSerialize(); + } + + return $value; + }, get_object_vars($this)); + } +} diff --git a/src/Apis/Encoding/Live/StreamKeys/StreamKeyPaginationResponse.php b/src/Apis/Encoding/Live/StreamKeys/StreamKeyPaginationResponse.php new file mode 100644 index 000000000..3f9e21bdd --- /dev/null +++ b/src/Apis/Encoding/Live/StreamKeys/StreamKeyPaginationResponse.php @@ -0,0 +1,19 @@ +items = ObjectMapper::map($this->items, StreamKey::class); + } +} diff --git a/src/Apis/Encoding/Live/StreamKeys/StreamKeysApi.php b/src/Apis/Encoding/Live/StreamKeys/StreamKeysApi.php new file mode 100644 index 000000000..91d103be1 --- /dev/null +++ b/src/Apis/Encoding/Live/StreamKeys/StreamKeysApi.php @@ -0,0 +1,91 @@ +httpWrapper = $httpWrapper ?? new HttpWrapper($config); + + } + + /** + * Create new stream key + * + * @param \BitmovinApiSdk\Models\StreamKey $streamKey + * @return \BitmovinApiSdk\Models\StreamKey + * @throws BitmovinApiException + */ + public function create(\BitmovinApiSdk\Models\StreamKey $streamKey) : \BitmovinApiSdk\Models\StreamKey + { + $response = $this->httpWrapper->request('POST', '/encoding/live/stream-keys', [], null, $streamKey, true); + + return ObjectMapper::map($response, \BitmovinApiSdk\Models\StreamKey::class); + } + + /** + * Delete Stream Key + * + * @param string $streamKeyId + * @return \BitmovinApiSdk\Models\BitmovinResponse + * @throws BitmovinApiException + */ + public function delete(string $streamKeyId) : \BitmovinApiSdk\Models\BitmovinResponse + { + $pathParams = [ + 'stream_key_id' => $streamKeyId, + ]; + + $response = $this->httpWrapper->request('DELETE', '/encoding/live/stream-keys/{stream_key_id}', $pathParams, null, null, true); + + return ObjectMapper::map($response, \BitmovinApiSdk\Models\BitmovinResponse::class); + } + + /** + * Stream Key details + * + * @param string $streamKeyId + * @return \BitmovinApiSdk\Models\StreamKey + * @throws BitmovinApiException + */ + public function get(string $streamKeyId) : \BitmovinApiSdk\Models\StreamKey + { + $pathParams = [ + 'stream_key_id' => $streamKeyId, + ]; + + $response = $this->httpWrapper->request('GET', '/encoding/live/stream-keys/{stream_key_id}', $pathParams, null, null, true); + + return ObjectMapper::map($response, \BitmovinApiSdk\Models\StreamKey::class); + } + + /** + * List Stream Keys + * + * @param StreamKeyListQueryParams|null $queryParams + * @return StreamKeyPaginationResponse + * @throws BitmovinApiException + */ + public function list(StreamKeyListQueryParams $queryParams = null) : StreamKeyPaginationResponse + { + $response = $this->httpWrapper->request('GET', '/encoding/live/stream-keys', [], $queryParams, null, true); + + return ObjectMapper::map($response, StreamKeyPaginationResponse::class); + } +} diff --git a/src/Common/Middleware/CustomApiHeaders.php b/src/Common/Middleware/CustomApiHeaders.php index 624eff688..59bff298e 100644 --- a/src/Common/Middleware/CustomApiHeaders.php +++ b/src/Common/Middleware/CustomApiHeaders.php @@ -17,7 +17,7 @@ public function __construct(string $apiKey, ?string $tenantOrgId) 'Content-Type' => 'application/json', 'X-Api-Key' => $apiKey, 'X-Api-Client' => 'bitmovin-api-sdk-php', - 'X-Api-Client-Version' => '1.183.2', + 'X-Api-Client-Version' => '1.184.1', ]; if ($tenantOrgId !== null) { diff --git a/src/Models/RedundantRtmpInput.php b/src/Models/RedundantRtmpInput.php index 1922c4801..9b5422f06 100644 --- a/src/Models/RedundantRtmpInput.php +++ b/src/Models/RedundantRtmpInput.php @@ -13,10 +13,14 @@ class RedundantRtmpInput extends Input /** @var \BitmovinApiSdk\Models\RtmpIngestPoint[] */ public $ingestPoints; + /** @var \BitmovinApiSdk\Models\StaticRtmpIngestPoint[] */ + public $staticIngestPoints; + public function __construct($attributes = null) { parent::__construct($attributes); $this->ingestPoints = ObjectMapper::map($this->ingestPoints, RtmpIngestPoint::class); + $this->staticIngestPoints = ObjectMapper::map($this->staticIngestPoints, StaticRtmpIngestPoint::class); } /** @@ -33,7 +37,7 @@ public function delayThreshold(int $delayThreshold) } /** - * ingestPoints + * Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live Either ingestPoints **or** staticIngestPoints can be set * * @param \BitmovinApiSdk\Models\RtmpIngestPoint[] $ingestPoints * @return $this @@ -44,5 +48,18 @@ public function ingestPoints(array $ingestPoints) return $this; } + + /** + * Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live Either ingestPoints **or** staticIngestPoints can be set + * + * @param \BitmovinApiSdk\Models\StaticRtmpIngestPoint[] $staticIngestPoints + * @return $this + */ + public function staticIngestPoints(array $staticIngestPoints) + { + $this->staticIngestPoints = $staticIngestPoints; + + return $this; + } } diff --git a/src/Models/StaticRtmpIngestPoint.php b/src/Models/StaticRtmpIngestPoint.php new file mode 100644 index 000000000..8c5382fc5 --- /dev/null +++ b/src/Models/StaticRtmpIngestPoint.php @@ -0,0 +1,64 @@ +streamKeyConfiguration = ObjectMapper::map($this->streamKeyConfiguration, StreamKeyConfiguration::class); + } + + /** + * The ID of the created static rtmp ingest point + * + * @param string $id + * @return $this + */ + public function id(string $id) + { + $this->id = $id; + + return $this; + } + + /** + * Name of the ingest point. This can be helpful for easier identifying your ingest points + * + * @param string $name + * @return $this + */ + public function name(string $name) + { + $this->name = $name; + + return $this; + } + + /** + * streamKeyConfiguration + * + * @param \BitmovinApiSdk\Models\StreamKeyConfiguration $streamKeyConfiguration + * @return $this + */ + public function streamKeyConfiguration(\BitmovinApiSdk\Models\StreamKeyConfiguration $streamKeyConfiguration) + { + $this->streamKeyConfiguration = $streamKeyConfiguration; + + return $this; + } +} + diff --git a/src/Models/StreamKey.php b/src/Models/StreamKey.php new file mode 100644 index 000000000..517eaf7e1 --- /dev/null +++ b/src/Models/StreamKey.php @@ -0,0 +1,45 @@ +status = ObjectMapper::map($this->status, StreamKeyStatus::class); + $this->type = ObjectMapper::map($this->type, StreamKeyType::class); + } + + /** + * 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. + * + * @param string $value + * @return $this + */ + public function value(string $value) + { + $this->value = $value; + + return $this; + } +} + diff --git a/src/Models/StreamKeyConfiguration.php b/src/Models/StreamKeyConfiguration.php new file mode 100644 index 000000000..0c9cbae44 --- /dev/null +++ b/src/Models/StreamKeyConfiguration.php @@ -0,0 +1,48 @@ +type = ObjectMapper::map($this->type, StreamKeyConfigurationType::class); + } + + /** + * type + * + * @param \BitmovinApiSdk\Models\StreamKeyConfigurationType $type + * @return $this + */ + public function type(\BitmovinApiSdk\Models\StreamKeyConfigurationType $type) + { + $this->type = $type; + + return $this; + } + + /** + * Id of the previously generated stream key. Only needed when the type is `ASSIGN`. + * + * @param string $streamKeyId + * @return $this + */ + public function streamKeyId(string $streamKeyId) + { + $this->streamKeyId = $streamKeyId; + + return $this; + } +} + diff --git a/src/Models/StreamKeyConfigurationType.php b/src/Models/StreamKeyConfigurationType.php new file mode 100644 index 000000000..1b3758c5a --- /dev/null +++ b/src/Models/StreamKeyConfigurationType.php @@ -0,0 +1,42 @@ +
EMPTY
+ StaticRtmpIngestPoint + + No description available + EMPTY +
Statistics @@ -24588,6 +24666,56 @@

\BitmovinApiSdk\Models

EMPTY
+ StreamKey + + No description available + EMPTY +
+ StreamKeyConfiguration + + No description available + EMPTY +
+ StreamKeyConfigurationType + + No description available + EMPTY +
+ StreamKeyStatus + + No description available + EMPTY +
+ StreamKeyType + + No description available + EMPTY +
StreamMetadata diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_EncodingApi.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_EncodingApi.html index b1621e153..c32ed2404 100644 --- a/docs/classes/BitmovinApiSdk_Apis_Encoding_EncodingApi.html +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_EncodingApi.html @@ -65,6 +65,7 @@

Synopsis

  • public ConfigurationsApi $configurations;
  • public FiltersApi $filters;
  • public EncodingsApi $encodings; +
  • public LiveApi $live;
  • public ManifestsApi $manifests;
  • public InfrastructureApi $infrastructure;
  • public StatisticsApi $statistics; @@ -101,6 +102,9 @@

    public

  • $inputs — BitmovinApiSdk\Apis\Encoding\Inputs\InputsApi
    • +
  • $live + — + BitmovinApiSdk\Apis\Encoding\Live\LiveApi
  • $manifests — BitmovinApiSdk\Apis\Encoding\Manifests\ManifestsApi
    • diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi.html new file mode 100644 index 000000000..b7188108d --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi.html @@ -0,0 +1,83 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\LiveApi + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\LiveApi

    +

    +

    +

    Synopsis

    +
    class LiveApi + {
    + + }
    +

    Members

    +
    +

    public

    + +
    +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi/__construct.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi/__construct.html new file mode 100644 index 000000000..488c34695 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_LiveApi/__construct.html @@ -0,0 +1,90 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\LiveApi::__construct + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\LiveApi::__construct

    +

    LiveApi constructor.

    +

    +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams.html new file mode 100644 index 000000000..0a1f7e092 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams.html @@ -0,0 +1,128 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams

    +

    +

    +

    Synopsis

    +
    class StreamKeyListQueryParams + implements + QueryParams + {
    • // methods
    • public static StreamKeyListQueryParams create() +
    • public StreamKeyListQueryParams offset() +
    • public StreamKeyListQueryParams limit() +
    • public StreamKeyListQueryParams sort() +
    • public StreamKeyListQueryParams type() +
    • public StreamKeyListQueryParams status() +
    • public StreamKeyListQueryParams assignedIngestPointId() +
    • public StreamKeyListQueryParams assignedEncodingId() +
    • public array toArray() +
    + + }
    +

    Hierarchy

    +
    +

    Implements

    + +
    +

    Methods

    +
    +

    public

    + +
    +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedEncodingId.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedEncodingId.html new file mode 100644 index 000000000..9addc5ec4 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedEncodingId.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::assignedEncodingId + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::assignedEncodingId

    +

    +

    +

      +

      Signature

      +
      + public function assignedEncodingId(string + $assignedEncodingId ) + +
      +

      Parameters

      +
      +
      $assignedEncodingId + — + string
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedIngestPointId.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedIngestPointId.html new file mode 100644 index 000000000..30537bccc --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/assignedIngestPointId.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::assignedIngestPointId + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::assignedIngestPointId

    +

    +

    +

      +

      Signature

      +
      + public function assignedIngestPointId(string + $assignedIngestPointId ) + +
      +

      Parameters

      +
      +
      $assignedIngestPointId + — + string
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/create.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/create.html new file mode 100644 index 000000000..cf4bce509 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/create.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::create + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::create

    +

    +

    +

      +

      Signature

      +
      + public function create() + +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/limit.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/limit.html new file mode 100644 index 000000000..8d81b18c5 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/limit.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::limit + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::limit

    +

    +

    +

      +

      Signature

      +
      + public function limit(int + $limit ) + +
      +

      Parameters

      +
      +
      $limit + — + int
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/offset.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/offset.html new file mode 100644 index 000000000..405fc5a82 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/offset.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::offset + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::offset

    +

    +

    +

      +

      Signature

      +
      + public function offset(int + $offset ) + +
      +

      Parameters

      +
      +
      $offset + — + int
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/sort.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/sort.html new file mode 100644 index 000000000..97971c4ad --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/sort.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::sort + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::sort

    +

    +

    +

      +

      Signature

      +
      + public function sort(string + $sort ) + +
      +

      Parameters

      +
      +
      $sort + — + string
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/status.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/status.html new file mode 100644 index 000000000..92bf3b631 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/status.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::status + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::status

    +

    +

    +

      +

      Signature

      +
      + public function status(string + $status ) + +
      +

      Parameters

      +
      +
      $status + — + string
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/toArray.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/toArray.html new file mode 100644 index 000000000..4be8fd97a --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/toArray.html @@ -0,0 +1,81 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::toArray + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::toArray

    +

    +

    +

    Signature

    +
    + public function toArray() + +
    +

    Defined by Interface

    +

    + + QueryParams + +

    +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/type.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/type.html new file mode 100644 index 000000000..67460ef80 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyListQueryParams/type.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::type + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyListQueryParams::type

    +

    +

    +

      +

      Signature

      +
      + public function type(string + $type ) + +
      +

      Parameters

      +
      +
      $type + — + string
      +
      +
      +

      Returns

      +
      +
      StreamKeyListQueryParams
      +

      +
      +
      +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse.html new file mode 100644 index 000000000..9474269d9 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse.html @@ -0,0 +1,155 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyPaginationResponse + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyPaginationResponse

    +

    +

    +

    Synopsis

    +
    class StreamKeyPaginationResponse + extends BasePaginationResponse + {
    • // members
    • public array $items; +
    • // Inherited methods from ApiResource
    • public void __construct() +
    • public static $this create() +
    • public void toArray() +
    + + }
    +

    Hierarchy

    +
    +

    Extends

    + +
    +

    Members

    +
    +

    public

    + +
    +

    Methods

    +
    +

    Inherited from BitmovinApiSdk\Common\BasePaginationResponse

    +

    public

    + +

    Inherited from BitmovinApiSdk\Common\ApiResource

    +

    public

    +
      +
    • + create() +
      • +
    • toArray() + — Create array with values, skip null and empty arrays
      • +
    +
    +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse/__construct.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse/__construct.html new file mode 100644 index 000000000..d495373cd --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeyPaginationResponse/__construct.html @@ -0,0 +1,83 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyPaginationResponse::__construct + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeyPaginationResponse::__construct

    +

    +

    +

    Signature

    +
    + public function __construct([ + $attributes = NULL] ) + +
    +

    Parameters

    +
    +
    $attributes + — +
    +
    +
    +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi.html new file mode 100644 index 000000000..e7e54041d --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi

    +

    +

    +

    Synopsis

    +
    class StreamKeysApi + {
    • // methods
    • public void __construct() +
    • public StreamKey create() +
    • public BitmovinResponse delete() +
    • public StreamKey get() +
    • public StreamKeyPaginationResponse list() +
    + + }
    +

    Methods

    +
    +

    public

    + +
    +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/__construct.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/__construct.html new file mode 100644 index 000000000..852a913eb --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/__construct.html @@ -0,0 +1,90 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::__construct + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::__construct

    +

    StreamKeysApi constructor.

    +

    +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/create.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/create.html new file mode 100644 index 000000000..d47d222d2 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/create.html @@ -0,0 +1,105 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::create + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::create

    +

    Create new stream key

    +

    +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/delete.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/delete.html new file mode 100644 index 000000000..5aea35e61 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/delete.html @@ -0,0 +1,105 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::delete + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::delete

    +

    Delete Stream Key

    +

    +

      +

      Signature

      +
      + public function delete(string + $streamKeyId ) + +
      +

      Parameters

      +
      +
      $streamKeyId + — + string
      +
      +
      +

      Returns

      +
      +
      BitmovinResponse
      +

      +
      +
      +

      Errors/Exceptions

      +
      +
      + + BitmovinApiException + +
      +
      +
      +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/get.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/get.html new file mode 100644 index 000000000..516608e96 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/get.html @@ -0,0 +1,105 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::get + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::get

    +

    Stream Key details

    +

    +

      +

      Signature

      +
      + public function get(string + $streamKeyId ) + +
      +

      Parameters

      +
      +
      $streamKeyId + — + string
      +
      +
      +

      Returns

      +
      +
      StreamKey
      +

      +
      +
      +

      Errors/Exceptions

      +
      +
      + + BitmovinApiException + +
      +
      +
      +
    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/list.html b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/list.html new file mode 100644 index 000000000..0b3c95b7f --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Apis_Encoding_Live_StreamKeys_StreamKeysApi/list.html @@ -0,0 +1,105 @@ + + + + + phpDox - BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::list + + + + + +
    +
    + +
    + +
    +

    BitmovinApiSdk\Apis\Encoding\Live\StreamKeys\StreamKeysApi::list

    +

    List Stream Keys

    +

    +

    +
    +
    + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
    + + diff --git a/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput.html b/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput.html index 0f63060b7..d786219b0 100644 --- a/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput.html +++ b/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput.html @@ -69,6 +69,7 @@

    Synopsis

    extends Input {
    • // Inherited members from BitmovinResource
    • public string $name; @@ -80,6 +81,7 @@

      Synopsis

    • // Inherited methods from Input
    • public void __construct()

    Methods

    @@ -148,7 +154,9 @@

    public

  • delayThreshold() — When there is no input signal present and this threshold in seconds is reached it will switch to another ingest point
  • ingestPoints() - — ingestPoints
    • + — Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live Either ingestPoints **or** staticIngestPoints can be set +
  • staticIngestPoints() + — Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live Either ingestPoints **or** staticIngestPoints can be set

    • Inherited from BitmovinApiSdk\Models\BitmovinResource

    public

    diff --git a/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/ingestPoints.html b/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/ingestPoints.html index 01721d97a..a1262efd7 100644 --- a/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/ingestPoints.html +++ b/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/ingestPoints.html @@ -62,7 +62,7 @@

    BitmovinApiSdk\Models\RedundantRtmpInput::ingestPoints

    -

    ingestPoints

    +

    Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live Either ingestPoints **or** staticIngestPoints can be set

        diff --git a/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/staticIngestPoints.html b/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/staticIngestPoints.html new file mode 100644 index 000000000..b5bf800b2 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_RedundantRtmpInput/staticIngestPoints.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\RedundantRtmpInput::staticIngestPoints + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\RedundantRtmpInput::staticIngestPoints

        +

        Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live Either ingestPoints **or** staticIngestPoints can be set

        +

        +

          +
            +

            Signature

            +
            + public function staticIngestPoints(array + $staticIngestPoints ) + +
            +

            Parameters

            +
            +
            $staticIngestPoints + — + array
            +



            +
            +

            Returns

            +
            +
            $this
            +

            +
            +
            +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint.html b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint.html new file mode 100644 index 000000000..5e62b6da1 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint.html @@ -0,0 +1,137 @@ + + + + + phpDox - BitmovinApiSdk\Models\StaticRtmpIngestPoint + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StaticRtmpIngestPoint

        +

        +

        +

        Synopsis

        +
        class StaticRtmpIngestPoint + extends ApiResource + {
        • // Inherited methods from ApiResource
        • public void __construct() +
        • public static $this create() +
        • public void toArray() +
        + + }
        +

        Hierarchy

        +
        +

        Extends

        + +
        +

        Members

        +
        +

        public

        + +
        +

        Methods

        +
        +

        public

        +
          +
        • + __construct() +
          • +
        • id() + — The ID of the created static rtmp ingest point
          • +
        • name() + — Name of the ingest point. This can be helpful for easier identifying your ingest points
          • +
        • streamKeyConfiguration() + — streamKeyConfiguration
          • +
        +

        Inherited from BitmovinApiSdk\Common\ApiResource

        +

        public

        +
          +
        • + create() +
          • +
        • toArray() + — Create array with values, skip null and empty arrays
          • +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/__construct.html b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/__construct.html new file mode 100644 index 000000000..ecfa49401 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/__construct.html @@ -0,0 +1,83 @@ + + + + + phpDox - BitmovinApiSdk\Models\StaticRtmpIngestPoint::__construct + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StaticRtmpIngestPoint::__construct

        +

        +

        +

        Signature

        +
        + public function __construct([ + $attributes = NULL] ) + +
        +

        Parameters

        +
        +
        $attributes + — +
        +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/id.html b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/id.html new file mode 100644 index 000000000..03cc5ae9b --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/id.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\StaticRtmpIngestPoint::id + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StaticRtmpIngestPoint::id

        +

        The ID of the created static rtmp ingest point

        +

        +

          +
            +

            Signature

            +
            + public function id(string + $id ) + +
            +

            Parameters

            +
            +
            $id + — + string
            +
            +
            +

            Returns

            +
            +
            $this
            +

            +
            +
            +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/name.html b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/name.html new file mode 100644 index 000000000..a715edd62 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/name.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\StaticRtmpIngestPoint::name + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StaticRtmpIngestPoint::name

        +

        Name of the ingest point. This can be helpful for easier identifying your ingest points

        +

        +

          +
            +

            Signature

            +
            + public function name(string + $name ) + +
            +

            Parameters

            +
            +
            $name + — + string
            +
            +
            +

            Returns

            +
            +
            $this
            +

            +
            +
            +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/streamKeyConfiguration.html b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/streamKeyConfiguration.html new file mode 100644 index 000000000..423f9ecaf --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StaticRtmpIngestPoint/streamKeyConfiguration.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\StaticRtmpIngestPoint::streamKeyConfiguration + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StaticRtmpIngestPoint::streamKeyConfiguration

        +

        streamKeyConfiguration

        +

        +

        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKey.html b/docs/classes/BitmovinApiSdk_Models_StreamKey.html new file mode 100644 index 000000000..f6db4b39d --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKey.html @@ -0,0 +1,178 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKey + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKey

        +

        +

        +

        Synopsis

        +
        class StreamKey + extends BitmovinResource + {
        • // Inherited members from BitmovinResponse
        • public string $id; +
        • // Inherited methods from BitmovinResponse
        • public void __construct() +
        • // Inherited methods from ApiResource
        • public void __construct() +
        • public static $this create() +
        • public void toArray() +
        + + }
        +

        Hierarchy

        +
        +

        Extends

        + +
        +

        Members

        +
        +

        public

        + +
        +

        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.
          • +
        +

        Inherited from BitmovinApiSdk\Common\ApiResource

        +

        public

        +
          +
        • + create() +
          • +
        • toArray() + — Create array with values, skip null and empty arrays
          • +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKey/__construct.html b/docs/classes/BitmovinApiSdk_Models_StreamKey/__construct.html new file mode 100644 index 000000000..465e8769b --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKey/__construct.html @@ -0,0 +1,83 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKey::__construct + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKey::__construct

        +

        +

        +

        Signature

        +
        + public function __construct([ + $attributes = NULL] ) + +
        +

        Parameters

        +
        +
        $attributes + — +
        +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKey/value.html b/docs/classes/BitmovinApiSdk_Models_StreamKey/value.html new file mode 100644 index 000000000..a09cc9d74 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKey/value.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKey::value + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKey::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.

        +

        +

          +
            +

            Signature

            +
            + public function value(string + $value ) + +
            +

            Parameters

            +
            +
            $value + — + string
            +
            +
            +

            Returns

            +
            +
            $this
            +

            +
            +
            +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration.html new file mode 100644 index 000000000..8d2def3a5 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration.html @@ -0,0 +1,130 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfiguration + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfiguration

        +

        +

        +

        Synopsis

        +
        class StreamKeyConfiguration + extends ApiResource + {
        • // members
        • public StreamKeyConfigurationType $type; +
        • public string $streamKeyId; +
        • // Inherited methods from ApiResource
        • public void __construct() +
        • public static $this create() +
        • public void toArray() +
        + + }
        +

        Hierarchy

        +
        +

        Extends

        + +
        +

        Members

        +
        +

        public

        + +
        +

        Methods

        +
        +

        public

        + +

        Inherited from BitmovinApiSdk\Common\ApiResource

        +

        public

        +
          +
        • + create() +
          • +
        • toArray() + — Create array with values, skip null and empty arrays
          • +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/__construct.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/__construct.html new file mode 100644 index 000000000..3f37641f2 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/__construct.html @@ -0,0 +1,83 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfiguration::__construct + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfiguration::__construct

        +

        +

        +

        Signature

        +
        + public function __construct([ + $attributes = NULL] ) + +
        +

        Parameters

        +
        +
        $attributes + — +
        +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/streamKeyId.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/streamKeyId.html new file mode 100644 index 000000000..b74fb49c8 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/streamKeyId.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfiguration::streamKeyId + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfiguration::streamKeyId

        +

        Id of the previously generated stream key. Only needed when the type is `ASSIGN`.

        +

        +

          +
            +

            Signature

            +
            + public function streamKeyId(string + $streamKeyId ) + +
            +

            Parameters

            +
            +
            $streamKeyId + — + string
            +
            +
            +

            Returns

            +
            +
            $this
            +

            +
            +
            +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/type.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/type.html new file mode 100644 index 000000000..723c5cc87 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfiguration/type.html @@ -0,0 +1,94 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfiguration::type + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfiguration::type

        +

        type

        +

        +

        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType.html new file mode 100644 index 000000000..3c47848db --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType.html @@ -0,0 +1,141 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfigurationType + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfigurationType

        +

        +

        +

        Synopsis

        +
        class StreamKeyConfigurationType + extends Enum + {
        • // methods
        • public static StreamKeyConfigurationType create() +
        • public static StreamKeyConfigurationType GENERATE() +
        • public static StreamKeyConfigurationType ASSIGN() +
        + + }
        +

        Hierarchy

        +
        +

        Extends

        + +
        +

        Methods

        +
        +

        public

        +
          +
        • ASSIGN() + — A previously generated reserved stream key will be assigned
          • +
        • GENERATE() + — A temporary stream key with a random 20 characters string will be generated
          • +
        • + create() +
          • +
        +

        Inherited from BitmovinApiSdk\Common\Enum

        +

        public

        +
          +
        • __callStatic() + — Returns a value when called statically like so: MyEnum::SOME_VALUE() given SOME_VALUE is a class constant
          • +
        • + __toString() +
          • +
        • equals() + — Determines if Enum should be considered equal with the variable passed as a parameter.
          • +
        • getKey() + — Returns the enum key (i.e. the constant name).
          • +
        • + getValue() +
          • +
        • isValidKey() + — Check if is valid enum key
          • +
        • jsonSerialize() + — Specify data which should be serialized to JSON. This method returns data that can be serialized by json_encode() natively.
          • +
        • keys() + — Returns the names (keys) of all constants in the Enum class
          • + +
        • toArray() + — Returns all possible values as an array
          • +
        • values() + — Returns instances of the Enum class of all Enum constants
          • +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/ASSIGN.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/ASSIGN.html new file mode 100644 index 000000000..9283ace99 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/ASSIGN.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfigurationType::ASSIGN + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfigurationType::ASSIGN

        +

        A previously generated reserved stream key will be assigned

        +

        +

          +

          Signature

          +
          + public function ASSIGN() + +
          +

          Returns

          +
          +
          StreamKeyConfigurationType
          +

          +
          +
          +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/GENERATE.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/GENERATE.html new file mode 100644 index 000000000..2b84f7147 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/GENERATE.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfigurationType::GENERATE + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfigurationType::GENERATE

        +

        A temporary stream key with a random 20 characters string will be generated

        +

        +

          +

          Signature

          +
          + public function GENERATE() + +
          +

          Returns

          +
          +
          StreamKeyConfigurationType
          +

          +
          +
          +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/create.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/create.html new file mode 100644 index 000000000..fb7efcd64 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyConfigurationType/create.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyConfigurationType::create + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyConfigurationType::create

        +

        +

        +

          +

          Signature

          +
          + public function create(string + $value ) + +
          +

          Parameters

          +
          +
          $value + — + string
          +
          +
          +

          Returns

          +
          +
          StreamKeyConfigurationType
          +

          +
          +
          +

        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus.html new file mode 100644 index 000000000..6ad542f01 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus.html @@ -0,0 +1,141 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyStatus + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyStatus

        +

        +

        +

        Synopsis

        +
        class StreamKeyStatus + extends Enum + {
        • // methods
        • public static StreamKeyStatus create() +
        • public static StreamKeyStatus ASSIGNED() +
        • public static StreamKeyStatus UNASSIGNED() +
        + + }
        +

        Hierarchy

        +
        +

        Extends

        + +
        +

        Methods

        +
        +

        public

        +
          +
        • ASSIGNED() + — Stream key is assigned to a live encoding. This means, it **can not be assigned** to a RedundantRtmpInput at the moment. It will be set to UNASSIGNED if the live encoding is finished or in error state
          • +
        • UNASSIGNED() + — Stream key is not assigned to a live encoding. This means, that it **is available** to be used with a RedundantRtmpInput
          • +
        • + create() +
          • +
        +

        Inherited from BitmovinApiSdk\Common\Enum

        +

        public

        +
          +
        • __callStatic() + — Returns a value when called statically like so: MyEnum::SOME_VALUE() given SOME_VALUE is a class constant
          • +
        • + __toString() +
          • +
        • equals() + — Determines if Enum should be considered equal with the variable passed as a parameter.
          • +
        • getKey() + — Returns the enum key (i.e. the constant name).
          • +
        • + getValue() +
          • +
        • isValidKey() + — Check if is valid enum key
          • +
        • jsonSerialize() + — Specify data which should be serialized to JSON. This method returns data that can be serialized by json_encode() natively.
          • +
        • keys() + — Returns the names (keys) of all constants in the Enum class
          • + +
        • toArray() + — Returns all possible values as an array
          • +
        • values() + — Returns instances of the Enum class of all Enum constants
          • +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/ASSIGNED.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/ASSIGNED.html new file mode 100644 index 000000000..6460c3cd9 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/ASSIGNED.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyStatus::ASSIGNED + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyStatus::ASSIGNED

        +

        Stream key is assigned to a live encoding. This means, it **can not be assigned** to a RedundantRtmpInput at the moment. It will be set to UNASSIGNED if the live encoding is finished or in error state

        +

        +

          +

          Signature

          +
          + public function ASSIGNED() + +
          +

          Returns

          +
          +
          StreamKeyStatus
          +

          +
          +
          +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/UNASSIGNED.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/UNASSIGNED.html new file mode 100644 index 000000000..1642838b8 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/UNASSIGNED.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyStatus::UNASSIGNED + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyStatus::UNASSIGNED

        +

        Stream key is not assigned to a live encoding. This means, that it **is available** to be used with a RedundantRtmpInput

        +

        +

          +

          Signature

          +
          + public function UNASSIGNED() + +
          +

          Returns

          +
          +
          StreamKeyStatus
          +

          +
          +
          +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/create.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/create.html new file mode 100644 index 000000000..dae6957e9 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyStatus/create.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyStatus::create + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyStatus::create

        +

        +

        +

          +

          Signature

          +
          + public function create(string + $value ) + +
          +

          Parameters

          +
          +
          $value + — + string
          +
          +
          +

          Returns

          +
          +
          StreamKeyStatus
          +

          +
          +
          +

        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyType.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyType.html new file mode 100644 index 000000000..7e839475e --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyType.html @@ -0,0 +1,141 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyType + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyType

        +

        +

        +

        Synopsis

        +
        class StreamKeyType + extends Enum + {
        • // methods
        • public static StreamKeyType create() +
        • public static StreamKeyType RESERVED() +
        • public static StreamKeyType TEMPORARY() +
        + + }
        +

        Hierarchy

        +
        +

        Extends

        + +
        +

        Methods

        +
        +

        public

        +
          +
        • RESERVED() + — Stream key is persistent and can be reused. It can be assigned to a live encoding when it is currently not in use
          • +
        • TEMPORARY() + — Stream key is automatically generated for a live encoding. They can not be reused. After the encoding is finished, the stream key will be gone also
          • +
        • + create() +
          • +
        +

        Inherited from BitmovinApiSdk\Common\Enum

        +

        public

        +
          +
        • __callStatic() + — Returns a value when called statically like so: MyEnum::SOME_VALUE() given SOME_VALUE is a class constant
          • +
        • + __toString() +
          • +
        • equals() + — Determines if Enum should be considered equal with the variable passed as a parameter.
          • +
        • getKey() + — Returns the enum key (i.e. the constant name).
          • +
        • + getValue() +
          • +
        • isValidKey() + — Check if is valid enum key
          • +
        • jsonSerialize() + — Specify data which should be serialized to JSON. This method returns data that can be serialized by json_encode() natively.
          • +
        • keys() + — Returns the names (keys) of all constants in the Enum class
          • + +
        • toArray() + — Returns all possible values as an array
          • +
        • values() + — Returns instances of the Enum class of all Enum constants
          • +
        +
        +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyType/RESERVED.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyType/RESERVED.html new file mode 100644 index 000000000..65e150be3 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyType/RESERVED.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyType::RESERVED + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyType::RESERVED

        +

        Stream key is persistent and can be reused. It can be assigned to a live encoding when it is currently not in use

        +

        +

          +

          Signature

          +
          + public function RESERVED() + +
          +

          Returns

          +
          +
          StreamKeyType
          +

          +
          +
          +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyType/TEMPORARY.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyType/TEMPORARY.html new file mode 100644 index 000000000..8801f24c8 --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyType/TEMPORARY.html @@ -0,0 +1,82 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyType::TEMPORARY + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyType::TEMPORARY

        +

        Stream key is automatically generated for a live encoding. They can not be reused. After the encoding is finished, the stream key will be gone also

        +

        +

          +

          Signature

          +
          + public function TEMPORARY() + +
          +

          Returns

          +
          +
          StreamKeyType
          +

          +
          +
          +
        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/classes/BitmovinApiSdk_Models_StreamKeyType/create.html b/docs/classes/BitmovinApiSdk_Models_StreamKeyType/create.html new file mode 100644 index 000000000..cb35143eb --- /dev/null +++ b/docs/classes/BitmovinApiSdk_Models_StreamKeyType/create.html @@ -0,0 +1,93 @@ + + + + + phpDox - BitmovinApiSdk\Models\StreamKeyType::create + + + + + +
        +
        + +
        + +
        +

        BitmovinApiSdk\Models\StreamKeyType::create

        +

        +

        +

          +

          Signature

          +
          + public function create(string + $value ) + +
          +

          Parameters

          +
          +
          $value + — + string
          +
          +
          +

          Returns

          +
          +
          StreamKeyType
          +

          +
          +
          +

        +
        +
        + Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2024 by Arne Blankerts and Contributors +
        + + diff --git a/docs/index.html b/docs/index.html index 79fe4aaf3..27099c29f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -34,7 +34,7 @@

        Software Documentation

        Build

        -

        Tue, 23 Jan 2024 15:54:21 +0000

        +

        Tue, 30 Jan 2024 16:24:46 +0000

        VCS Info

        tag:
        diff --git a/docs/namespaces.html b/docs/namespaces.html index 474576259..1e704291a 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -2953,6 +2953,22 @@

        Namespaces

    		 0
    \BitmovinApiSdk\Apis\Encoding\Live0 + 1 + 0
    \BitmovinApiSdk\Apis\Encoding\Live\StreamKeys0 + 3 + 0
    \BitmovinApiSdk\Apis\Encoding\Manifests 0 \BitmovinApiSdk\Models 0 - 814 + 820 0