CML
    Preparing search index...

    Module @svta/cml-error-codes

    A collection of standardized streaming error codes defined by the Streaming Video Technology Alliance (SVTA).

    @svta/cml-error-codes

    SVTA2070 standardized streaming error codes.

    This package is the reference implementation of SVTA2070: Standardized Error Codes. The specification defines one error vocabulary for every video player. Each code is a short integer. The thousands digits identify the category, such as Playback or Network. The last three digits identify the specific error. HTTP response statuses and IAB VAST error codes embed into the scheme at their own values.

    npm i @svta/cml-error-codes
    

    The package has one peer dependency, @svta/cml-utils. The package imports it only with import type, so nothing from it appears in the runtime output.

    Codes are grouped into one catalog per category. Each catalog is an as const object, so autocomplete lists the valid members:

    import assert from "node:assert";
    import { getSvtaErrorCategory, SvtaErrorCategory, SvtaPlaybackErrorCode } from "@svta/cml-error-codes";

    const code = SvtaPlaybackErrorCode.VIDEO_BUFFER_UNDERRUN;

    assert(code === 2001);
    assert(getSvtaErrorCategory(code) === SvtaErrorCategory.PLAYBACK);

    Every code is also an individual constant:

    import assert from "node:assert";
    import { SVTA_RESOURCE_NOT_FOUND } from "@svta/cml-error-codes";

    assert(SVTA_RESOURCE_NOT_FOUND === 3004);

    HTTP response statuses embed into the Network category. IAB VAST error codes embed into the Advertising category. The four-digit VAST error 1009 (empty VAST response) maps to 7999.

    import assert from "node:assert";
    import { httpStatusToSvtaErrorCode, vastErrorToSvtaErrorCode } from "@svta/cml-error-codes";

    assert(httpStatusToSvtaErrorCode(404) === 3404);
    assert(vastErrorToSvtaErrorCode(301) === 7301);
    assert(vastErrorToSvtaErrorCode(1009) === 7999);

    The helpers never throw. Out-of-range input returns the unknown code of the target category, 3000 or 7000.

    Enumerations

    SvtaAccessibilityErrorCode
    SvtaAdvertisingErrorCode
    SvtaContentProtectionErrorCode
    SvtaCustomErrorCode
    SvtaErrorCategory
    SvtaMediaContentErrorCode
    SvtaNetworkErrorCode
    SvtaPlaybackErrorCode
    SvtaRemotePlayErrorCode
    SvtaUnknownErrorCode

    Type Aliases

    SvtaErrorCode

    Variables

    SVTA_ACCESSIBILITY_UNKNOWN
    SVTA_AD_BLOCKER_DETECTED
    SVTA_AD_TYPE_MISMATCH
    SVTA_ADVERTISING_UNKNOWN
    SVTA_AUDIO_BUFFER_UNDERRUN
    SVTA_AUDIO_BUFFERING_TIMEOUT
    SVTA_AUDIO_DECODE_ERROR
    SVTA_AUDIO_DESCRIPTION_EXCEEDS_CONTENT_DURATION
    SVTA_BAD_LICENSE_REQUEST
    SVTA_BUFFER_APPEND_ERROR
    SVTA_BUFFER_FULL_ERROR
    SVTA_BUFFER_INITIALIZATION_ERROR
    SVTA_BUFFER_NUDGE_ON_STALL
    SVTA_BUFFER_REMOVE_ERROR
    SVTA_BUFFER_SEEK_OVER_HOLE
    SVTA_CDN_UNAUTHORIZED
    SVTA_COMPANION_AD_ERROR
    SVTA_COMPANION_AD_FETCH_ERROR
    SVTA_COMPANION_DIMENSION_MISMATCH
    SVTA_CONCURRENT_STREAM_LIMIT_EXCEEDED
    SVTA_CONTENT_PROTECTION_UNKNOWN
    SVTA_CONTENT_STEERING_MANIFEST_LOAD_ERROR
    SVTA_CONTENT_STEERING_MANIFEST_PARSE_ERROR
    SVTA_CUSTOM_UNKNOWN
    SVTA_DOWNLOAD_ERROR
    SVTA_DRM_CERTIFICATE_ERROR
    SVTA_DRM_CONFIGURATION_MISSING
    SVTA_DRM_INITIALIZATION_ERROR
    SVTA_DRM_SESSION_ERROR
    SVTA_DURATION_MISMATCH
    SVTA_EMPTY_VAST_RESPONSE
    SVTA_EMPTY_WRAPPER_RESPONSE
    SVTA_ENTITLEMENT_REFUSED
    SVTA_ERROR_CATEGORY_ACCESSIBILITY
    SVTA_ERROR_CATEGORY_ADVERTISING
    SVTA_ERROR_CATEGORY_CONTENT_PROTECTION
    SVTA_ERROR_CATEGORY_CUSTOM
    SVTA_ERROR_CATEGORY_MEDIA_CONTENT
    SVTA_ERROR_CATEGORY_NETWORK
    SVTA_ERROR_CATEGORY_PLAYBACK
    SVTA_ERROR_CATEGORY_REMOTE_PLAY
    SVTA_ERROR_CATEGORY_UNKNOWN
    SVTA_FRAGMENT_LOAD_ERROR
    SVTA_FRAGMENT_TIMEOUT_ERROR
    SVTA_FULLSCREEN_ERROR
    SVTA_GEO_RESTRICTED
    SVTA_HOST_RESOLUTION_ERROR
    SVTA_HTTP_TIMEOUT
    SVTA_INITIALIZATION_SEGMENT_ERROR
    SVTA_INSUFFICIENT_BANDWIDTH
    SVTA_INSUFFICIENT_DRM_ROBUSTNESS
    SVTA_INSUFFICIENT_OUTPUT_PROTECTION
    SVTA_INTERACTIVE_CREATIVE_ERROR
    SVTA_INVALID_ACCESS_TOKEN
    SVTA_INVALID_COMPOSITION_TRACK_SEGMENT_TIME
    SVTA_INVALID_HTTP_CONTENT_TYPE
    SVTA_INVALID_MANIFEST
    SVTA_INVALID_URI
    SVTA_KEY_LOAD_ERROR
    SVTA_LICENSE_EXPIRED
    SVTA_LICENSE_REQUEST_GENERATION_ERROR
    SVTA_LICENSE_RESPONSE_REJECTED
    SVTA_LICENSE_SERVER_TIMEOUT
    SVTA_LINEAR_AD_ERROR
    SVTA_LINEARITY_MISMATCH
    SVTA_LIVE_TIMESHIFT_OUT_OF_BOUNDS
    SVTA_MANIFEST_FEATURE_UNSUPPORTED
    SVTA_MANIFEST_PARSE_ERROR
    SVTA_MANIFEST_TRACK_PARSE_ERROR
    SVTA_MAX_RETRIES_EXCEEDED
    SVTA_MEDIA_CONTENT_UNKNOWN
    SVTA_MEDIA_FILE_DISPLAY_ERROR
    SVTA_MEDIA_FILE_NOT_FOUND
    SVTA_MEDIA_FILE_UNAVAILABLE
    SVTA_MEDIA_UNAVAILABLE
    SVTA_MEZZANINE_DOWNLOADING
    SVTA_MEZZANINE_MISSING
    SVTA_MISALIGNED_TRACK_DURATION
    SVTA_NETWORK_UNKNOWN
    SVTA_NO_MATCHING_CODEC
    SVTA_NO_NETWORK_CONNECTION
    SVTA_NO_SUPPORTED_AUDIO_TRACK
    SVTA_NO_SUPPORTED_MEDIA_TYPE
    SVTA_NO_SUPPORTED_VIDEO_TRACK
    SVTA_NONLINEAR_AD_ERROR
    SVTA_NONLINEAR_AD_FETCH_ERROR
    SVTA_NONLINEAR_DIMENSION_MISMATCH
    SVTA_OUT_OF_MEMORY
    SVTA_PERMISSION_REJECTED
    SVTA_PERSISTENT_SESSION_ERROR
    SVTA_PICTURE_IN_PICTURE_ERROR
    SVTA_PLAYBACK_UNKNOWN
    SVTA_PLAYHEAD_EXCEEDS_CONTENT_DURATION
    SVTA_PRIMARY_MANIFEST_LOAD_ERROR
    SVTA_PRIMARY_MANIFEST_LOAD_TIMEOUT
    SVTA_RECEIVER_ALREADY_IN_REMOTE_PLAY
    SVTA_RECEIVER_CONNECTION_LOST
    SVTA_RECEIVER_CONNECTION_REFUSED
    SVTA_RECEIVER_PLAYBACK_ERROR
    SVTA_RECEIVER_UNAVAILABLE
    SVTA_RECEIVER_UNSUPPORTED_STREAM
    SVTA_REJECTED_AD
    SVTA_REMOTE_PLAY_UNKNOWN
    SVTA_REMUX_ERROR
    SVTA_REQUIRED_COMPANION_AD_ERROR
    SVTA_RESOURCE_DENIED
    SVTA_RESOURCE_NOT_FOUND
    SVTA_SECONDARY_MANIFEST_LOAD_ERROR
    SVTA_SECONDARY_MANIFEST_PARSE_ERROR
    SVTA_SEGMENT_DECRYPTION_ERROR
    SVTA_SEGMENT_EXCEEDS_TRACK_BITRATE
    SVTA_SEGMENT_LOAD_ERROR
    SVTA_SEGMENT_PARSE_ERROR
    SVTA_SEGMENT_TIMEOUT_ERROR
    SVTA_SENDER_CONNECTION_ERROR
    SVTA_SENDER_CONNECTION_LOST
    SVTA_SENDER_INITIALIZATION_ERROR
    SVTA_SIZE_MISMATCH
    SVTA_SWITCHED_TO_HIGHER_LATENCY
    SVTA_TIME_SYNC_ERROR
    SVTA_TIMED_TEXT_EXCEEDS_CONTENT_DURATION
    SVTA_TIMED_TEXT_PARSE_ERROR
    SVTA_TIMED_TEXT_RENDER_ERROR
    SVTA_TRACK_LOAD_ERROR
    SVTA_TRACK_NOT_AVAILABLE
    SVTA_TRACK_SWITCH_ERROR
    SVTA_UNDEFINED_VAST_ERROR
    SVTA_UNKNOWN
    SVTA_UNSUPPORTED_AUDIO_FORMAT
    SVTA_UNSUPPORTED_DRM_SYSTEM
    SVTA_UNSUPPORTED_NONLINEAR_AD
    SVTA_UNSUPPORTED_TEXT_FORMAT
    SVTA_UNSUPPORTED_URI_SCHEME
    SVTA_UNSUPPORTED_VIDEO_FORMAT
    SVTA_VAST_PARSE_ERROR
    SVTA_VAST_SCHEMA_VALIDATION_ERROR
    SVTA_VAST_VERSION_UNSUPPORTED
    SVTA_VERIFICATION_ERROR
    SVTA_VIDEO_BUFFER_UNDERRUN
    SVTA_VIDEO_BUFFERING_TIMEOUT
    SVTA_VIDEO_DECODE_ERROR
    SVTA_VIDEO_DROPPED_FRAMES_EXCEEDED
    SVTA_VPAID_ERROR
    SVTA_WRAPPER_ERROR
    SVTA_WRAPPER_LIMIT_REACHED
    SVTA_WRAPPER_TIMEOUT

    Functions

    getSvtaErrorCategory
    getSvtaErrorIndex
    httpStatusToSvtaErrorCode
    vastErrorToSvtaErrorCode