Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaVaultStreamsClient

Hierarchy

  • MediaVaultStreamsClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected mediaVaultStreamsRoute

mediaVaultStreamsRoute: MediaVaultStreamsRoute

Accessors

routeDefinition

Methods

create

  • create(data: any, stream: any): PromiseLike<IHttpResponse<any>>

  • Returns a promise that is resolved once the create media vault stream action has been performed; this action will upload the specified blob. For more information on Blob objects please see Blob Documentation.

    method
    example

    mediaVaultStreamsClient.create('', ) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: any
    • stream: any

    Returns PromiseLike<IHttpResponse<any>>

get

  • Returns a promise that is resolved once the get action has been performed. Success response returns the media vault stream if successfully completed. If derived resource's format is passed, such as width and height for the image type of media vault resource, the operation will return a stream of the derived resource. Otherwise, stream of the original media vault resource will be retrieved.

    method
    example

    // Request the original media vault stream mediaVaultStreamsClient.get('') .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // Request derived media vault stream mediaVaultStreamsClient.get({id: '', width: , height: }) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: any

    Returns PromiseLike<IHttpResponse<any>>

getBlob

  • Returns a promise that is resolved once the get action has been performed. Success response returns the media vault stream as a blob. If derived resource's format is passed, such as width and height for the image type of media vault resource, the operation will return a blob of the derived media vault resource. Otherwise, blob of the original media vault resource will be retrieved. For more information on Blob objects please see Blob Documentation.

    method
    example

    // Request the original blob mediaVaultStreamsClient.getBlob('') .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // Request derived blob mediaVaultStreamsClient.getBlob({id: '', width: , height: }) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: any

    Returns PromiseLike<IHttpResponse<any>>

update

  • update(data: any, stream: any): PromiseLike<IHttpResponse<any>>

  • Returns a promise that is resolved once the update media vault stream action has been performed; this action will replace the existing stream with a new one. Alternatively, if a derived stream is being updated it will either create a new derived stream or replace the existing one. In order to update a derived stream, format needs to be passed (For example: width and height for the image type of media vault stream data type).

    method
    example

    // Update existing original media vault stream mediaVaultStreamsClient.update('', ) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // Update derived media vault stream mediaVaultStreamsClient.update({id: '', width: , height: }, ) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: any
    • stream: any

    Returns PromiseLike<IHttpResponse<any>>

Generated using TypeDoc