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

    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;
    }
    Index

    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: Date

    Date when the publish token was created.

    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: string[]

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

    Not currently supported with RTMP.

    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.

    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.

    Not currently supported with RTMP.

    clip: boolean

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

    Live clipping is currently in Beta phase.

    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: boolean

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

    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

    • OptionalallowedCountries?: 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.

    • OptionaldeniedCountries?: 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.

    • OptionaloriginCluster?: string

      Cluster to route specified streams to.

    enableThumbnails?: boolean

    Is thumbnails generation enabled or not.

    expiresOn?: Date

    Date at which the publish token expires.

    geoCascade: PublishTokenGeoCascade

    Geo cascade settings for cascading stream to other clusters.

    id: string

    Identifier of the publish token.

    isActive: boolean

    Is the publish token active or not.

    label: string

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

    lowLatencyRtmp?: boolean

    Is low latency mode for RTMP ingest enabled or not.

    multisource: boolean

    Is multisource enabled or not.

    originCluster: string

    Cluster to route specified streams to.

    record: boolean

    Is the publish token allowed to record the specified streams.

    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

    Restream is currently in Beta phase.

    srtPassphrase?: string

    The SRT passphrase.

    streams: PublishTokenStream[]

    List of stream names.

    subscribeRequiresAuth: boolean

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

    token: string

    Publish token.

    Settings

    Member Visibility

    On This Page

    Properties