@dolbyio/dolbyio-rest-apis-client - v6.0.0
    Preparing search index...

    Interface UpdatePublishToken

    Represents the changes requested for a publish token.

    interface UpdatePublishToken {
        addTokenStreams?: PublishTokenStream[];
        allowedCountries?: string[];
        allowedIpAddresses?: string[];
        allowedOrigins?: string[];
        bindIpsOnUsage?: number;
        clip?: boolean;
        deniedCountries?: string[];
        displaySrtPassphrase?: boolean;
        enableThumbnails?: boolean;
        geoCascade?: PublishTokenGeoCascade;
        isActive?: boolean;
        label?: string;
        lowLatencyRtmp?: boolean;
        multisource?: boolean;
        originCluster?: string;
        priority?: number;
        record?: boolean;
        refreshToken?: boolean;
        removeTokenStreams?: PublishTokenStream[];
        restream?: RestreamTarget[];
        subscribeRequiresAuth?: boolean;
    }
    Index

    Properties

    addTokenStreams? allowedCountries? allowedIpAddresses? allowedOrigins? bindIpsOnUsage? clip? deniedCountries? displaySrtPassphrase? enableThumbnails? geoCascade? isActive? label? lowLatencyRtmp? multisource? originCluster? priority? record? refreshToken? removeTokenStreams? restream? subscribeRequiresAuth?

    Properties

    addTokenStreams?: PublishTokenStream[]

    List of stream names to add to the list.

    allowedCountries?: string[]

    Update the list of allowed countries.

    allowedIpAddresses?: string[]

    Update the list of allows IP addresses.

    allowedOrigins?: string[]

    Update the list of allowed origins.

    bindIpsOnUsage?: number

    Update the bind IPs on usage value.

    clip?: boolean

    Allow or disallow to create clips of the specified streams.

    deniedCountries?: string[]

    Update the list of denied countries.

    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.

    geoCascade?: PublishTokenGeoCascade

    Update the geo cascading rules for this publish token.

    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.

    originCluster?: string

    Update the origin cluster.

    priority?: number

    Set default priority value for streams. Set to null to clear value.

    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.

    restream?: RestreamTarget[]

    List of endpoints to restream media.

    subscribeRequiresAuth?: boolean

    Is authentication required to subscribe to the specified streams.

    Settings

    Member Visibility

    On This Page

    Properties