Interface PublishToken

Represents a publish token.

interface PublishToken {
    addedOn: Date;
    allowedCountries: string[];
    allowedIpAddresses: string[];
    allowedOrigins: string[];
    bindIpsOnUsage?: number;
    clip: boolean;
    deniedCountries: string[];
    displaySrtPassphrase: boolean;
    effectiveSettings: {
        allowedCountries?: string[];
        deniedCountries?: string[];
        geoCascade: PublishTokenGeoCascade;
        originCluster?: string;
    };
    enableThumbnails?: boolean;
    expiresOn?: Date;
    geoCascade: PublishTokenGeoCascade;
    id: string;
    isActive: boolean;
    label: string;
    lowLatencyRtmp?: boolean;
    multisource: boolean;
    originCluster: string;
    record: boolean;
    restream: {
        key: string;
        url: string;
    }[];
    srtPassphrase?: string;
    streams: PublishTokenStream[];
    subscribeRequiresAuth: boolean;
    token: string;
}

Properties

addedOn allowedCountries allowedIpAddresses allowedOrigins bindIpsOnUsage? clip deniedCountries displaySrtPassphrase effectiveSettings enableThumbnails? expiresOn? geoCascade id isActive label lowLatencyRtmp? multisource originCluster record restream srtPassphrase? streams subscribeRequiresAuth token

Properties

addedOn

addedOn: Date

Date when the publish token was created.

allowedCountries

allowedCountries: string[]

Specify the ISO 3166-1 two letter country codes to explicitly allow viewer to watch the stream from. If the viewer's location does not match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of allowed countries can be overridden by the subscribe token.

allowedIpAddresses

allowedIpAddresses: string[]

May specify multiple IPv4 addresses or CIDR notated network blocks. If specified, the token will only be usable from those IP addresses.

Note

Not currently supported with RTMP.

allowedOrigins

allowedOrigins: string[]

If specified only the domains in list will be allowed in requests to Director API with token. Wildcard subdomains are also allowed, e.g.: "*.demo.com". When unspecified (empty list) there are no domain restrictions.

Optional bindIpsOnUsage

bindIpsOnUsage?: number

If specified will bind the token to the first X IP addresses used with token in requests to Director API, thus restricting the token to those IP addresses without being known beforehand.

Note

Not currently supported with RTMP.

Beta clip

clip: boolean

Is the publish token allowed to create clips the specified streams.

Remarks

Live clipping is currently in Beta phase.

deniedCountries

deniedCountries: string[]

Specify the ISO 3166-1 two letter country codes to explicitly deny viewer to watch the stream from. If the viewer's location does match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of denied countries can be overridden by the subscribe token.

displaySrtPassphrase

displaySrtPassphrase: boolean

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

effectiveSettings

effectiveSettings: {
    allowedCountries?: string[];
    deniedCountries?: string[];
    geoCascade: PublishTokenGeoCascade;
    originCluster?: string;
}

Token effective settings for properties that use account default settings. Value for each property will either be token or account level settings.

Type declaration

  • Optional allowedCountries?: string[]

    Specify the ISO 3166-1 two letter country codes to explicitly allow viewer to watch the stream from. If the viewer's location does not match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of allowed countries can be overridden by the subscribe token.

  • Optional deniedCountries?: string[]

    Specify the ISO 3166-1 two letter country codes to explicitly deny viewer to watch the stream from. If the viewer's location does match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of denied countries can be overridden by the subscribe token.

  • geoCascade: PublishTokenGeoCascade

    Geo cascade settings for cascading stream to other clusters.

  • Optional originCluster?: string

    Cluster to route specified streams to.

Optional enableThumbnails

enableThumbnails?: boolean

Is thumbnails generation enabled or not.

Optional expiresOn

expiresOn?: Date

Date at which the publish token expires.

geoCascade

geoCascade: PublishTokenGeoCascade

Geo cascade settings for cascading stream to other clusters.

id

id: string

Identifier of the publish token.

isActive

isActive: boolean

Is the publish token active or not.

label

label: string

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

Optional lowLatencyRtmp

lowLatencyRtmp?: boolean

Is low latency mode for RTMP ingest enabled or not.

multisource

multisource: boolean

Is multisource enabled or not.

originCluster

originCluster: string

Cluster to route specified streams to.

record

record: boolean

Is the publish token allowed to record the specified streams.

Beta restream

restream: {
    key: string;
    url: string;
}[]

List of endpoints to restream the stream.

Type declaration

  • key: string

    Secret key for restreaming endpoint.

  • url: string

    The endpoint to restream media

Remarks

Restream is currently in Beta phase.

Optional srtPassphrase

srtPassphrase?: string

The SRT passphrase.

streams

streams: PublishTokenStream[]

List of stream names.

subscribeRequiresAuth

subscribeRequiresAuth: boolean

Does the publish token require authentication to subscribe to the specified streams.

token

token: string

Publish token.

Settings

Member Visibility

Theme

On This Page

addedOnallowedCountriesallowedIpAddressesallowedOriginsbindIpsOnUsageclipdeniedCountriesdisplaySrtPassphraseeffectiveSettingsenableThumbnailsexpiresOngeoCascadeidisActivelabellowLatencyRtmpmultisourceoriginClusterrecordrestreamsrtPassphrasestreamssubscribeRequiresAuthtoken