A-Tractor - v2.3.1
    Preparing search index...

    Interface IMediaPlayerOptions

    Options for the MediaPlayer.

    interface IMediaPlayerOptions {
        analyzerClass?: AbstractAnalyzer;
        analyzerOptions?: any;
        buttonVolumeClassActive?: string;
        mediaElement?: string | HTMLMediaElement;
        mediaSourcePreload?: TMediaSourcePreload;
        mediaStateOptions?: IMediaStateOptions;
        mediaTimePointerOptions?: IMediaTimePointerOptions;
        mediaType?: MediaType;
        position?: number;
        poster?: string;
        removeMediaOnDestroy?: boolean;
        template?: string;
        videoElementClass?: string;
        viewElement?: string | HTMLElement;
        viewElementClass?: string;
        viewElementTag?: string;
        viewSelectors?: {
            analyzer: string;
            buttonPlay: string;
            buttonVolume: string;
            poster: string;
            timePointer: string;
            timerDuration: string;
            timerElapsed: string;
            timerRemaining: string;
            volumeLevel: string;
            volumeSlider: string;
            volumeValue: string;
        };
        volume?: number;
    }
    Index

    Properties

    analyzerClass? analyzerOptions? buttonVolumeClassActive? mediaElement? mediaSourcePreload? mediaStateOptions? mediaTimePointerOptions? mediaType? position? poster? removeMediaOnDestroy? template? videoElementClass? viewElement? viewElementClass? viewElementTag? viewSelectors? volume?

    Properties

    analyzerClass?: AbstractAnalyzer

    Class of audio analyzer to visualize audio.

    • For audio source is set to WaveformAnalyzer by default.
    • For video source is set to null by default and should be set manually if needed.
    analyzerOptions?: any

    Audio analyzer options if needed.

    buttonVolumeClassActive?: string

    CSS class to add to buttonVolume element if panel with volumeSlider is open. By default active.

    mediaElement?: string | HTMLMediaElement

    CSS selector or reference to the HTML media element taken as the source of media data. Auto created by default.

    mediaSourcePreload?: TMediaSourcePreload

    Strategy to preload media content. By default metadata.

    mediaStateOptions?: IMediaStateOptions

    MediaState component options if needed.

    mediaTimePointerOptions?: IMediaTimePointerOptions

    MediaTimePointer component options if needed.

    mediaType?: MediaType

    The type of media data created by default. By default MediaType.AUDIO.

    position?: number

    Initial time position offset in seconds.

    poster?: string

    URL of poster image for the media source.

    removeMediaOnDestroy?: boolean

    Possible cases:

    • TRUE means always remove media element when destroy method is called.
    • FALSE means never remove media element when destroy method is called.
    • UNDEFINED means remove media element only if it was automatically created.
    template?: string

    HTML template with Media player structure. By default defined by TEMPLATE_WITH_HORIZONTAL_VOLUME_SLIDER.

    videoElementClass?: string

    CSS class to add to auto created video element. By default poster.

    viewElement?: string | HTMLElement

    CSS selector or HTML container element to render player content. Auto created by default.

    viewElementClass?: string

    CSS class for player container HTML element. By default media-player-item.

    viewElementTag?: string

    Tag of player container HTML element. By default div.

    viewSelectors?: {
        analyzer: string;
        buttonPlay: string;
        buttonVolume: string;
        poster: string;
        timePointer: string;
        timerDuration: string;
        timerElapsed: string;
        timerRemaining: string;
        volumeLevel: string;
        volumeSlider: string;
        volumeValue: string;
    }

    List of CSS selectors to bind view elements. May be redefined if custom template is used for Media player.

    Bindings by default:

    - poster: '.poster'
- analyzer: '.analyzer'
- timePointer: '.time-pointer'
- timerElapsed: '.timer.elapsed'
- timerRemaining: '.timer.remaining'
- timerDuration: '.timer.duration'
- buttonPlay: '.button-play'
- buttonVolume: '.button-volume'
- volumeSlider: '.volume-slider'
- volumeLevel: '.volume-level'
- volumeValue: '.volume-value'
    volume?: number

    Initial media source volume. Value should be in range of [0 - 1] (it means: 0 - 100%).

    Settings

    Member Visibility

    On This Page

    Properties