@dolbyio/dolbyio-rest-apis-client - v5.1.1
    Preparing search index...

    Interface UpdatePublishToken

    Represents the changes requested for a publish token.

    interface UpdatePublishToken {
        addTokenStreams?: PublishTokenStream[];
        clip?: boolean;
        displaySrtPassphrase?: boolean;
        enableThumbnails?: boolean;
        isActive?: boolean;
        label?: string;
        lowLatencyRtmp?: boolean;
        multisource?: boolean;
        record?: boolean;
        refreshToken?: boolean;
        removeTokenStreams?: PublishTokenStream[];
        subscribeRequiresAuth?: boolean;
        updateAllowedCountries?: string[];
        updateAllowedIpAddresses?: string[];
        updateAllowedOrigins?: string[];
        updateBindIpsOnUsage?: number;
        updateDeniedCountries?: string[];
        updateGeoCascade?: PublishTokenGeoCascade;
        updateOriginCluster?: string;
        updateRestream?: { key: string; url: string }[];
    }
    Index

    Properties

    addTokenStreams? clip? displaySrtPassphrase? enableThumbnails? isActive? label? lowLatencyRtmp? multisource? record? refreshToken? removeTokenStreams? subscribeRequiresAuth? updateAllowedCountries? updateAllowedIpAddresses? updateAllowedOrigins? updateBindIpsOnUsage? updateDeniedCountries? updateGeoCascade? updateOriginCluster? updateRestream?

    Properties

    addTokenStreams?: PublishTokenStream[]

    List of stream names to add to the list.

    clip?: boolean

    Allow or disallow to create clips of the specified streams.

    Live clipping is currently in Beta phase.

    displaySrtPassphrase?: boolean

    Display passphrase encryption settings in the dashboard as well as returning the SRT passphrase in response to this API call.

    enableThumbnails?: boolean

    Enable or disable thumbnails generation.

    isActive?: boolean

    Enables or disable the publish token.

    label?: string

    Name for the token that is used to display in the dashboard.

    lowLatencyRtmp?: boolean

    Enable or disable the low latency mode for RTMP ingest.

    multisource?: boolean

    Enable or disable the multi source capability for this publish token.

    record?: boolean

    Allow or disallow to record the specified streams.

    refreshToken?: boolean

    Refresh the publish token.

    removeTokenStreams?: PublishTokenStream[]

    List of stream names to remove from the list.

    subscribeRequiresAuth?: boolean

    Is authentication required to subscribe to the specified streams.

    updateAllowedCountries?: string[]

    Update the list of allowed countries.

    updateAllowedIpAddresses?: string[]

    Update the list of allows IP addresses.

    updateAllowedOrigins?: string[]

    Update the list of allowed origins.

    updateBindIpsOnUsage?: number

    Update the bind IPs on usage value.

    updateDeniedCountries?: string[]

    Update the list of denied countries.

    updateGeoCascade?: PublishTokenGeoCascade

    Update the geo cascading rules for this publish token.

    updateOriginCluster?: string

    Update the origin cluster.

    updateRestream?: { key: string; url: string }[]

    List of endpoints to restream media.

    Type Declaration

    • key: string

      Secret key for restreaming endpoint.

    • url: string

      The endpoint to restream the stream

    Restream is currently in Beta phase.

    Settings

    Member Visibility

    On This Page

    Properties