OGPlayer Web SDK
    Preparing search index...

    Interface OGUIConfig

    Per-control visibility + behavior — Android's OGUiConfig counterpart.

    interface OGUIConfig {
        adBlockerPolicy: "none" | "notice" | "block";
        adPauseIconSvg?: string;
        adPlayIconSvg?: string;
        audioTrackIconSvg?: string;
        colors?: Partial<OGControlColors>;
        contentRatingsTimeoutMs: number;
        controlsTimeoutMs: number;
        customActions: CustomAction[];
        dimens?: Partial<OGControlDimens>;
        doubleClickToSeek: boolean;
        errorMessageProvider?: (error: OGPlayerError) => string | null | undefined;
        fullscreenEnterIconSvg?: string;
        fullscreenExitIconSvg?: string;
        onFullscreenExitRequest?: () => void;
        pauseIconSvg?: string;
        playIconSvg?: string;
        qualityIconSvg?: string;
        replayIconSvg?: string;
        retryButtonLabel: string;
        seekBackwardIconSvg?: string;
        seekForwardIconSvg?: string;
        showAdCueMarkers: boolean;
        showAudioTrackButton: boolean;
        showContentRatings: boolean;
        showFullscreenButton: boolean;
        showProgressBar: boolean;
        showQualityButton: boolean;
        showRetryButton: boolean;
        showSeekButtons: boolean;
        showSpeedButton: boolean;
        showSubtitleButton: boolean;
        showTimeLabels: boolean;
        showTitle: boolean;
        showVolumeButton: boolean;
        speedIconSvg?: string;
        subtitlesIconSvg?: string;
        titleStyle?: string;
        titleTimeoutMs: number;
        volumeMuteIconSvg?: string;
        volumeOnIconSvg?: string;
    }
    Index
    adBlockerPolicy adPauseIconSvg? adPlayIconSvg? audioTrackIconSvg? colors? contentRatingsTimeoutMs controlsTimeoutMs customActions dimens? doubleClickToSeek errorMessageProvider? fullscreenEnterIconSvg? fullscreenExitIconSvg? onFullscreenExitRequest? pauseIconSvg? playIconSvg? qualityIconSvg? replayIconSvg? retryButtonLabel seekBackwardIconSvg? seekForwardIconSvg? showAdCueMarkers showAudioTrackButton showContentRatings showFullscreenButton showProgressBar showQualityButton showRetryButton showSeekButtons showSpeedButton showSubtitleButton showTimeLabels showTitle showVolumeButton speedIconSvg? subtitlesIconSvg? titleStyle? titleTimeoutMs volumeMuteIconSvg? volumeOnIconSvg?
    adBlockerPolicy: "none" | "notice" | "block"

    What happens when an ad blocker is detected (error 902):

    • "notice": content plays ad-free with a dismissible nudge (default)
    • "block": playback stops and the video is hidden until the viewer disables the blocker and reloads — the hard broadcaster line
    • "none": the SDK stays quiet; the host handles the 902 event itself
    adPauseIconSvg?: string
    adPlayIconSvg?: string
    audioTrackIconSvg?: string
    colors?: Partial<OGControlColors>

    Chrome theming — partial overrides merged over the OGPlayer defaults (mobile parity: OGControlColors / OGControlDimens).

    contentRatingsTimeoutMs: number
    controlsTimeoutMs: number
    customActions: CustomAction[]
    dimens?: Partial<OGControlDimens>
    doubleClickToSeek: boolean
    errorMessageProvider?: (error: OGPlayerError) => string | null | undefined

    Your own error-overlay text, in any language — called with the full OGPlayerError (stable codes: 2000 network, 3000 source, 4000 DRM, 5000 renderer, 6000 live, 9000 unknown). Return null/undefined for the SDK default. The error object still reaches onError unchanged.

    fullscreenEnterIconSvg?: string
    fullscreenExitIconSvg?: string
    onFullscreenExitRequest?: () => void

    When set, the fullscreen-exit button calls this instead of leaving fullscreen — the host decides (typically: close the screen). Mobile parity: onFullscreenExitRequest. The browser's own Esc key still exits directly (platform behavior that cannot be intercepted).

    pauseIconSvg?: string
    playIconSvg?: string

    Glyph overrides — inline SVG markup, tinted like the chrome (mobile parity: setPlayIcon / setPauseIcon / setSeekForwardIcon …).

    qualityIconSvg?: string
    replayIconSvg?: string
    retryButtonLabel: string

    Label of the Retry button (default "Retry").

    seekBackwardIconSvg?: string
    seekForwardIconSvg?: string
    showAdCueMarkers: boolean

    Yellow VMAP break dots on the scrubber (mobile parity).

    showAudioTrackButton: boolean
    showContentRatings: boolean
    showFullscreenButton: boolean
    showProgressBar: boolean
    showQualityButton: boolean
    showRetryButton: boolean

    Show a Retry button on the error overlay (default true). Retry reloads the failed item — VOD resumes where playback stopped.

    showSeekButtons: boolean
    showSpeedButton: boolean
    showSubtitleButton: boolean
    showTimeLabels: boolean
    showTitle: boolean
    showVolumeButton: boolean
    speedIconSvg?: string
    subtitlesIconSvg?: string
    titleStyle?: string

    Extra CSS applied to the title overlay (mobile parity: titleTextStyle / titleFont), e.g. font-size:22px; font-family:Georgia;.

    titleTimeoutMs: number
    volumeMuteIconSvg?: string
    volumeOnIconSvg?: string

    Settings
    Member Visibility

    On This Page
    Properties