Vinyl
    Preparing search index...

    Interface DmlsOptions

    interface DmlsOptions {
        appMetadata?: Maybe<dmls.StreamingAppMetadata>;
        authCookie?: Maybe<ValueProvider<true>>;
        clientMetadata: dmls.ClientMetadata;
        csrfTokenProvider?: Maybe<CsrfTokenProvider>;
        customer?: Maybe<DmlsCustomerOptions>;
        deviceToken: dmls.DeviceToken;
        enableFlacOpus?: Maybe<boolean>;
        firefoxClearLeadEnabled?: Maybe<boolean>;
        host: string;
        marketplaceId: string;
        musicTerritory: Territory;
    }
    Index

    Properties

    appMetadata? authCookie? clientMetadata csrfTokenProvider? customer? deviceToken enableFlacOpus? firefoxClearLeadEnabled? host marketplaceId musicTerritory

    Properties

    appMetadata?: Maybe<dmls.StreamingAppMetadata>

    Application metadata (optional).

    authCookie?: Maybe<ValueProvider<true>>

    If set, customer.oAuthTokenProvider will be considered optional for DMLS services that require authentication. This should provide true, or () => Promise<true> to indicate that the cookie is fresh and ready to use.

    clientMetadata: dmls.ClientMetadata

    Client metadata. E.g. { clientId: 'WebCP' } for web player.

    csrfTokenProvider?: Maybe<CsrfTokenProvider>

    Provides a promise to the csrf token.

    customer?: Maybe<DmlsCustomerOptions>

    The currently authenticated customer. Note: setting DMLS options without a customer will cause asin and coid tracks to fail. If customer entitlement and auth is async, do not set dmls options until the customer options are ready.

    deviceToken: dmls.DeviceToken

    Device type id and device id.

    enableFlacOpus?: Maybe<boolean>

    If true, Dash requests will use the musicDashVersionList SIREN_KATANA, which will include Flac and Opus assets. This must be true to enable HD. Default: true

    firefoxClearLeadEnabled?: Maybe<boolean>

    If true, Firefox will request media with clear lead: SIREN_KATANA If false (default), Firefox will request: SIREN_KATANA_NO_CLEAR_LEAD. Firefox could not decode Opus with clear lead due to https://bugzilla.mozilla.org/show_bug.cgi?id=1762980 While this bug hasn't been closed, the issue is no longer reproducible with Firefox 130

    host: string

    The host of the DMLS server. E.g. https://music.amazon.com

    marketplaceId: string

    The marketplaceId, retrieved from Stratus. E.g. 'ATVPDKIKX0DER'

    musicTerritory: Territory

    The music territory, retrieved from Stratus. E.g. 'US'

    Settings

    Member Visibility

    On This Page

    Properties