Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Video

Class representing a Video resource with helper functions.s

Hierarchy

  • Media
    • Video

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_meta

_meta: VideoMeta

Metadata about the Video

Protected config

config: CommonContentClientConfig

defaultHost

defaultHost: string

Default host name to use when constructing a URL to the resource. Your application may override this value with a branded host name in the SDK configuration.

endpoint

endpoint: string

Name of the account to use when constructing a URL to the resource.

id

id: string

ID of the media object

mimeType

mimeType: string | undefined

Mime type of the media object

name

name: string

Name of the media object to use when constructing a URL to the resource.

Methods

getHost

  • getHost(secure: boolean): string

  • Returns the hostname that should be used to load this media resource. The hostname will use the staging and media host overrides if specified otherwise it will use the defaultHost provided by the delivery API.

    Parameters

    • secure: boolean

    Returns string

thumbnail

  • Returns a builder which can be used to construct a video thumbnail URL. You can apply transformations such as resize and image format using the returned builder.

    video.thumbnail().width(500).build();

    Returns ImageUrlBuilder

toJSON

  • toJSON(): any

Generated using TypeDoc