Options
All
  • Public
  • Public/Protected
  • All
Menu

@bitmovin/api-sdk

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AbstractConditionUnion

AbstractConditionUnion: Condition | AndConjunction | OrConjunction

AdAnalyticsAbstractFilterUnion

AdAnalyticsAbstractFilterUnion: AdAnalyticsInFilter | AdAnalyticsEqualFilter | AdAnalyticsNotEqualFilter | AdAnalyticsLessThanFilter | AdAnalyticsLessThanOrEqualFilter | AdAnalyticsGreaterThanFilter | AdAnalyticsGreaterThanOrEqualFilter | AdAnalyticsContainsFilter | AdAnalyticsNotContainsFilter

AdaptationSetUnion

AdaptationSetUnion: VideoAdaptationSet | AudioAdaptationSet | ImageAdaptationSet | SubtitleAdaptationSet

AnalyticsAbstractFilterUnion

AnalyticsAbstractFilterUnion: AnalyticsInFilter | AnalyticsEqualFilter | AnalyticsNotEqualFilter | AnalyticsLessThanFilter | AnalyticsLessThanOrEqualFilter | AnalyticsGreaterThanFilter | AnalyticsGreaterThanOrEqualFilter | AnalyticsContainsFilter | AnalyticsNotContainsFilter

AnalyticsOutputUnion

AnalyticsOutputUnion: AnalyticsS3RoleBasedOutput | AnalyticsGcsServiceAccountOutput | AnalyticsAzureOutput

Callable

Callable<T>: object

Type parameters

  • T

Type declaration

CodecConfigurationUnion

CodecConfigurationUnion: AacAudioConfiguration | DtsPassthroughAudioConfiguration | DtsAudioConfiguration | DtsXAudioConfiguration | DvbSubtitleConfiguration | HeAacV1AudioConfiguration | HeAacV2AudioConfiguration | H264VideoConfiguration | H265VideoConfiguration | Vp9VideoConfiguration | Vp8VideoConfiguration | Mp2AudioConfiguration | Mp3AudioConfiguration | Ac3AudioConfiguration | DolbyDigitalAudioConfiguration | Eac3AudioConfiguration | DolbyDigitalPlusAudioConfiguration | OpusAudioConfiguration | VorbisAudioConfiguration | MjpegVideoConfiguration | Av1VideoConfiguration | DolbyAtmosAudioConfiguration | H262VideoConfiguration | PcmAudioConfiguration | WebVttConfiguration | ImscConfiguration

DashRepresentationUnion

DashRepresentationUnion: DashFmp4DrmRepresentation | DashFmp4Representation | DashWebmRepresentation | DashCmafRepresentation | DashChunkedTextRepresentation | DashMp4Representation | DashMp4DrmRepresentation | DashProgressiveWebmRepresentation | DashVttRepresentation | SpriteRepresentation | DashImscRepresentation | ContentProtection

DefaultManifestConditionUnion

DefaultManifestConditionUnion: DefaultManifestAttributeCondition | DefaultManifestAndCondition | DefaultManifestOrCondition

DrmUnion

DrmUnion: WidevineDrm | PlayReadyDrm | PrimeTimeDrm | FairPlayDrm | MarlinDrm | ClearKeyDrm | AesEncryptionDrm | CencDrm | SpekeDrm

FetchAPI

FetchAPI: function

Type declaration

    • (url: string, init: any): Promise<Response>

    • Parameters

      • url: string
      • Optional init: any

      Returns Promise<Response>

FilterUnion

FilterUnion: CropFilter | ConformFilter | WatermarkFilter | EnhancedWatermarkFilter | RotateFilter | DeinterlaceFilter | EnhancedDeinterlaceFilter | AudioMixFilter | DenoiseHqdn3dFilter | TextFilter | UnsharpFilter | ScaleFilter | InterlaceFilter | AudioVolumeFilter | EbuR128SinglePassFilter

Id3TagUnion

Id3TagUnion: RawId3Tag | FrameIdId3Tag | PlaintextId3Tag

InputStreamUnion

InputStreamUnion: IngestInputStream | ConcatenationInputStream | TimeBasedTrimmingInputStream | TimecodeTrackTrimmingInputStream | H264PictureTimingTrimmingInputStream | AudioMixInputStream | DolbyVisionMetadataIngestInputStream | Cea608CaptionInputStream | Cea708CaptionInputStream | FileInputStream | DvbSubtitleInputStream | DvbTeletextInputStream | DolbyAtmosIngestInputStream | DolbyVisionInputStream

InputUnion

InputUnion: AkamaiNetStorageInput | AsperaInput | AzureInput | RedundantRtmpInput | FtpInput | GenericS3Input | GcsInput | HttpInput | HttpsInput | LocalInput | RtmpInput | S3Input | S3RoleBasedInput | SftpInput | TcpInput | UdpInput | UdpMulticastInput | ZixiInput | SrtInput | GcsServiceAccountInput

MuxingUnion

MuxingUnion: Fmp4Muxing | CmafMuxing | Mp4Muxing | TsMuxing | WebmMuxing | Mp3Muxing | MxfMuxing | ProgressiveWebmMuxing | ProgressiveMovMuxing | ProgressiveTsMuxing | BroadcastTsMuxing | ChunkedTextMuxing | TextMuxing | SegmentedRawMuxing | PackedAudioMuxing

OutputUnion

OutputUnion: AkamaiNetStorageOutput | AzureOutput | CdnOutput | GenericS3Output | GcsOutput | FtpOutput | LocalOutput | S3Output | S3RoleBasedOutput | SftpOutput | AkamaiMslOutput | LiveMediaIngestOutput | GcsServiceAccountOutput

SidecarFileUnion

SidecarFileUnion: WebVttSidecarFile

SimpleEncodingLiveJobOutputUnion

SimpleEncodingLiveJobOutputUnion: SimpleEncodingLiveJobUrlOutput | SimpleEncodingLiveJobCdnOutput

SimpleEncodingVodJobOutputUnion

SimpleEncodingVodJobOutputUnion: SimpleEncodingVodJobUrlOutput | SimpleEncodingVodJobCdnOutput

Variables

Const BASE_URL

BASE_URL: "https://api.bitmovin.com/v1" = "https://api.bitmovin.com/v1"

Functions

appendLine

  • appendLine(message: string, messageToAppend: string): string

  • Parameters

    • message: string
    • messageToAppend: string

    Returns string

appendRequestMessage

  • appendRequestMessage(request: any): string

  • Parameters

    • request: any

    Returns string

appendResponseMessage

  • appendResponseMessage(response: any, errorResponse: any): string

  • Parameters

    • response: any
    • Optional errorResponse: any

    Returns string

buildBitmovinDetailMessage

  • buildBitmovinDetailMessage(details: Message): string

  • Parameters

    Returns string

buildBitmovinError

  • buildBitmovinError(additionalInfo: string, request: any, response: any, errorResponse: any | string, error: Error): BitmovinError

  • Parameters

    • additionalInfo: string
    • request: any
    • response: any
    • Optional errorResponse: any | string
    • Optional error: Error

    Returns BitmovinError

buildBitmovinErrorFromError

  • buildBitmovinErrorFromError(request: any, error: Error): BitmovinError

  • Parameters

    • request: any
    • error: Error

    Returns BitmovinError

buildDetails

  • buildDetails(details: Message[]): string

  • Parameters

    Returns string

buildLinks

  • buildLinks(links: Link[]): string

  • Parameters

    Returns string

calculateType

  • Type parameters

    • T

    Parameters

    Returns Callable<T>

copyAndPrepareBody

  • copyAndPrepareBody(value: any): any

  • Parameters

    • value: any

    Returns any

getShortMessage

  • getShortMessage(additionalInfo: String, errorResponse: any): string

  • Parameters

    • additionalInfo: String
    • errorResponse: any

    Returns string

isPrimitive

  • isPrimitive(arg: any): boolean

  • Parameters

    • arg: any

    Returns boolean

map

  • map<T>(value: T | undefined, clazz: Callable<T>): T

  • Type parameters

    • T

    Parameters

    • value: T | undefined
    • Optional clazz: Callable<T>

    Returns T

mapArray

  • mapArray<T>(value: T[] | undefined, clazz: Callable<T>): T[]

  • Type parameters

    • T

    Parameters

    • value: T[] | undefined
    • Optional clazz: Callable<T>

    Returns T[]

mapInternal

  • mapInternal<T>(value: any, clazz: Callable<T>): T

  • Type parameters

    • T

    Parameters

    • value: any
    • Optional clazz: Callable<T>

    Returns T

prepareUrl

  • prepareUrl(baseUrl: string, url: string, urlParameterMap: any, queryStringParameters: any): URL

  • Parameters

    • baseUrl: string
    • url: string
    • urlParameterMap: any
    • queryStringParameters: any

    Returns URL

prepareUrlParameterValue

  • prepareUrlParameterValue(parameterValue: any): any

  • Parameters

    • parameterValue: any

    Returns any

queryParams

  • queryParams(params: any): string

  • Parameters

    • params: any

    Returns string

Generated using TypeDoc