Type alias CoreStateAtoms

CoreStateAtoms: {
    CodecMap: {
        copyCodecs: typeof copyCodecs;
        createCodecMapAtom: typeof createCodecMapAtom;
    };
    DataStream: {
        DataStreamClearedError: typeof DataStreamClearedError;
        DataStreamClosedError: typeof DataStreamClosedError;
        createDataStreamAtom: typeof createDataStreamAtom;
    };
    Metrics: {
        createMetricsAtom: typeof createMetricsAtom;
        network: {
            SampleType: typeof Type;
            createNetworkSampleAtom: typeof createNetworkSampleAtom;
        };
    };
    Queue: {
        QueueItemRemovedError: typeof QueueItemRemovedError;
        createQueueAtom: typeof createQueueAtom;
    };
    SegmentTimeline: {
        createStreamSectionAtom: typeof createStreamSectionAtom;
        createStreamSequenceMapAtom: typeof createStreamSequenceMapAtom;
        createStreamTimelineAtom: typeof createStreamTimelineAtom;
    };
    Segments: {
        ContainerFormat: typeof ContainerFormat;
        createDataSegmentAtom: typeof createDataSegmentAtom;
        createInitSegmentAtom: typeof createInitSegmentAtom;
        createSegmentDataAtom: typeof createSegmentDataAtom;
        createSegmentTiming: typeof createSegmentTiming;
        createSelfInitSegmentAtom: typeof createSelfInitSegmentAtom;
        getGapToNextSegment: typeof getGapToNextSegment;
        getReadableSegmentName: typeof getReadableSegmentName;
        getTimeRange: typeof getTimeRange;
        isDataOrSelfInitSegment: typeof isDataOrSelfInitSegment;
        isDataSegment: typeof isDataSegment;
        isInitSegment: typeof isInitSegment;
    } & typeof SegmentUtils;
    SelectionGroups: {
        createAudioSelectionGroupAtom: typeof createAudioSelectionGroupAtom;
        createSubtitleSelectionGroupAtom: typeof createSubtitleSelectionGroupAtom;
        createUnknownSelectionGroupAtom: typeof createUnknownSelectionGroupAtom;
        createVideoSelectionGroupAtom: typeof createVideoSelectionGroupAtom;
        isAudioSelectionGroup: typeof isAudioSelectionGroup;
        isMediaSelectionGroup: typeof isMediaSelectionGroup;
        isSubtitleSelectionGroup: typeof isSubtitleSelectionGroup;
        isVideoSelectionGroup: typeof isVideoSelectionGroup;
    } & typeof SelectionGroupUtils;
    StateMachine: {
        createStateMachineAtom: typeof createStateMachineAtom;
        flushPendingUpdates: typeof flushPendingUpdates;
    };
    Stream: {
        Type: typeof StreamType;
        createStreamAtom: typeof createStreamAtom;
    };
    Tracks: {
        createAudioTrackAtom: typeof createAudioTrackAtom;
        createMuxedTrackAtom: typeof createMuxedTrackAtom;
        createSubtitleTrackAtom: typeof createSubtitleTrackAtom;
        createUnknownTrackAtom: typeof createUnknownTrackAtom;
        createVideoTrackAtom: typeof createVideoTrackAtom;
        isAudioTrack: typeof isAudioTrack;
        isMediaOrSubtitleTrack: typeof isMediaOrSubtitleTrack;
        isMediaTrack: typeof isMediaTrack;
        isMuxedTrack: typeof isMuxedTrack;
        isSubtitleTrack: typeof isSubtitleTrack;
        isVideoTrack: typeof isVideoTrack;
    };
    createArrayAtom: typeof createArrayAtom;
    createMapStateAtom: typeof createMapStateAtom;
    createPrimitiveAtom: typeof createPrimitiveAtom;
}

The core state atoms make up the data structures on which the player as a whole, operates.

This main object is designed to be exposed on the registry for easy access. It consists of the atom creators for all the core state atoms, along with a number of predicates that can be used to test various assertions.

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc