Vinyl
    Preparing search index...

    Interface StreamingTerminatedAttributes

    Base properties for Amazon Music Metrics Tracking Service (MTS) events related to playback.

    interface StreamingTerminatedAttributes {
        asin: null | string;
        bitrates: string;
        cacheHitStatus: CacheHitStatus;
        cdnType: null | string;
        cdObjectId: null | string;
        contentSubscriptionMode: ContentSubscriptionMode;
        durationMilliseconds: number;
        durationSeconds: number;
        durationSecondsSum: number;
        extra?: any;
        rebufferCount: number;
        source: StreamingSource;
        streamOrDRMTech: null | StreamOrDrmTech;
        substituteAsin: null | string;
        transferSpeedBPS: null | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    asin: null | string

    An "Amazon Standard Identification Number". Catalogue entries are unique to marketplace, ASIN pairs.

    https://w.amazon.com/bin/view/ASIN/ https://console.harmony.a2z.com/music-metrics/docs/attribute/asin

    bitrates: string

    One of BitrateName Will be prefixed with 'Auto' if ABR is active.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/bitrates

    cacheHitStatus: CacheHitStatus

    This attribute represents how much of a cache was available relative to the event.

    Note: this differs from Harley, VinylAmzn uses the cacheHitStatus relative to the event, Harley uses cacheHitStatus as it was relative to initiation.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/cacheHitStatus

    cdnType: null | string

    Tracks which CDN is used for streaming events. This attribute helps the Delivery and Playback teams investigate differences in music streaming.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/cdnType

    cdObjectId: null | string

    Represents the Cloud Drive Unique Identifier of the song that is in the user's library. Either asin or cdObjectId will be non-null.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/cdObjectId

    contentSubscriptionMode: ContentSubscriptionMode
    durationMilliseconds: number

    durationSeconds

    durationSeconds: number

    This is the playback duration in seconds of the track since the start of the track or since the last interruption.

    For live streaming, "start of the track" is the point where the user first started listening (not the start of the stream).

    durationSecondsSum: number

    The durationSecondsSum attribute represents the cumulative track listening time.

    Differently from the durationSeconds attribute, the durationSecondsSum does not reset to zero every time the playback stops (for example, on pause), but keeps counting the listening time (does not account for paused time) until the track playback is finished.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/durationSecondsSum

    extra?: any

    The application extra data set via track load options.

    rebufferCount: number

    The rebufferCount represents the number of customer impacting streamingRequiredReBuffering events that occur for this streaming terminated event. Note that rebuffer count in this case is assumed to be any distinct interruptions with a non-zero rebuffer time delay that occur for a track being listened to by the customer. The intent behind this attribute is to leverage PMET to get a better approximation of the percentage of tracks streamed that experience a customer impacting rebuffer.

    This count should not include:

    rebuffer events that are not customer impacting: That is, rebuffer events can by definition only happen when the track is being listened to. If it is being pre-fetched and not listened to, then such an interruption is not customer impacting. rebuffer events with zero delay: if the delay was zero then by definition the buffering event was not customer impacting.

    For web playback, 'WIFI' will always be reported unless local playback is supported. If local playback is supported and cacheHitStatus is FULL, then LOCAL will be reported.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/source

    streamOrDRMTech: null | StreamOrDrmTech

    What type of stream, e.g. Dash with DRM, HLS, Progressive.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/streamOrDRMTech

    substituteAsin: null | string

    Indicates that the track played was substituted in favor over the track in the asin attribute of the same event.

    https://console.harmony.a2z.com/music-metrics/docs/attribute/substituteAsin

    transferSpeedBPS: null | number

    The transfer speed is the average throughput for all recent network requests, where "recent" is some window of time just prior to the event. Important: This is in Bytes per second, not bits per second as most bandwidth values are measured.

    VinylAmzn/Vinyl slightly differs from Harley in this metric, Harley uses a rolling average where, after a fragment has loaded, a new average is calculated by averaging transfer speeds within a 60s window. Vinyl however, uses an exponentially weighted average, weighing more recent transfers more than older transfers. The result is similar without the need for a rolling history and prevents the possibility of one data point replacing all previous history.