1. trait
  2. Cloudinary
  3. \
  4. Api
  5. \
  6. Admin
  7. \
  8. StreamingProfilesTrait

StreamingProfilesTrait

trait StreamingProfilesTrait

Enables you to manage streaming profiles for use with adaptive bitrate streaming.

Learn more: Streaming Profiles method - Admin API

Properties

ApiClient $apiClient Defined in AdminApi class

Methods

listStreamingProfiles()

Lists streaming profiles including built-in and custom profiles.

getStreamingProfile(string $name)

Gets details of a single streaming profile by name.

deleteStreamingProfile(string $name)

Deletes or reverts the specified streaming profile.

updateStreamingProfile(string $name, array $options = [])

Updates an existing streaming profile.

createStreamingProfile(string $name, array $options = [])

Creates a new, custom streaming profile.

Details

ApiResponse listStreamingProfiles()

Lists streaming profiles including built-in and custom profiles.

Return Value

ApiResponse An array with a "data" key for results.

Exceptions

ApiError

See also

https://cloudinary.com/documentation/admin_api#get_adaptive_streaming_profiles

ApiResponse getStreamingProfile(string $name)

Gets details of a single streaming profile by name.

Parameters

Name Type Description
$name string The identification name of the streaming profile

Return Value

ApiResponse An array with a "data" key for results.

Exceptions

ApiError

See also

https://cloudinary.com/documentation/admin_api#get_details_of_a_single_streaming_profile

ApiResponse deleteStreamingProfile(string $name)

Deletes or reverts the specified streaming profile.

For custom streaming profiles, deletes the specified profile. For built-in streaming profiles, if the built-in profile was modified, reverts the profile to the original settings. For built-in streaming profiles that have not been modified, the Delete method returns an error.

Parameters

Name Type Description
$name string The name of the streaming profile to delete or revert.

Return Value

ApiResponse

Exceptions

ApiError

See also

https://cloudinary.com/documentation/admin_api#delete_or_revert_the_specified_streaming_profile

ApiResponse updateStreamingProfile(string $name, array $options = [])

Updates an existing streaming profile.

You can update both custom and built-in profiles. The specified list of representations replaces the previous list.

Parameters

Name Type Description
$name string The name of the streaming profile to update.
$options array The optional parameters. See the Admin API documentation.

Return Value

ApiResponse

Exceptions

ApiError

See also

https://cloudinary.com/documentation/admin_api#create_a_streaming_profile

ApiResponse createStreamingProfile(string $name, array $options = [])

Creates a new, custom streaming profile.

Parameters

Name Type Description
$name string The name to assign to the new streaming profile. The name is case-insensitive and can contain alphanumeric characters, underscores (_) and hyphens (-). If the name is of a predefined profile, the profile will be modified.
$options array The optional parameters. See the Admin API documentation.

Return Value

ApiResponse

Exceptions

ApiError

See also

StreamingProfilesTrait::createStreamingProfile
https://cloudinary.com/documentation/admin_api#create_a_streaming_profile