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;
    }[];
}

Properties

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

Properties

Optional addTokenStreams

addTokenStreams?: PublishTokenStream[]

List of stream names to add to the list.

Optional Beta clip

clip?: boolean

Allow or disallow to create clips of the specified streams.

Remarks

Live clipping is currently in Beta phase.

Optional displaySrtPassphrase

displaySrtPassphrase?: boolean

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

Optional enableThumbnails

enableThumbnails?: boolean

Enable or disable thumbnails generation.

Optional isActive

isActive?: boolean

Enables or disable the publish token.

Optional label

label?: string

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

Optional lowLatencyRtmp

lowLatencyRtmp?: boolean

Enable or disable the low latency mode for RTMP ingest.

Optional multisource

multisource?: boolean

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

Optional record

record?: boolean

Allow or disallow to record the specified streams.

Optional refreshToken

refreshToken?: boolean

Refresh the publish token.

Optional removeTokenStreams

removeTokenStreams?: PublishTokenStream[]

List of stream names to remove from the list.

Optional subscribeRequiresAuth

subscribeRequiresAuth?: boolean

Is authentication required to subscribe to the specified streams.

Optional updateAllowedCountries

updateAllowedCountries?: string[]

Update the list of allowed countries.

Optional updateAllowedIpAddresses

updateAllowedIpAddresses?: string[]

Update the list of allows IP addresses.

Optional updateAllowedOrigins

updateAllowedOrigins?: string[]

Update the list of allowed origins.

Optional updateBindIpsOnUsage

updateBindIpsOnUsage?: number

Update the bind IPs on usage value.

Optional updateDeniedCountries

updateDeniedCountries?: string[]

Update the list of denied countries.

Optional updateGeoCascade

updateGeoCascade?: PublishTokenGeoCascade

Update the geo cascading rules for this publish token.

Optional updateOriginCluster

updateOriginCluster?: string

Update the origin cluster.

Optional Beta updateRestream

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

Remarks

Restream is currently in Beta phase.

Settings

Member Visibility

Theme

On This Page

addTokenStreamsclipdisplaySrtPassphraseenableThumbnailsisActivelabellowLatencyRtmpmultisourcerecordrefreshTokenremoveTokenStreamssubscribeRequiresAuthupdateAllowedCountriesupdateAllowedIpAddressesupdateAllowedOriginsupdateBindIpsOnUsageupdateDeniedCountriesupdateGeoCascadeupdateOriginClusterupdateRestream