OGPlayer React Native SDK
    Preparing search index...

    Interface OGUIConfig

    interface OGUIConfig {
        adPauseIconName?: string;
        adPlayIconName?: string;
        audioTrackIconName?: string;
        castConnectedIconName?: string;
        castIconName?: string;
        customActions?: CustomActionConfig[];
        errorMessages?: Record<string, string>;
        errorTextColor?: string;
        errorTextFontFamily?: string;
        errorTextSize?: number;
        fullscreenEnterIconName?: string;
        fullscreenExitIconName?: string;
        hideAllControls?: boolean;
        pauseIconName?: string;
        playIconName?: string;
        retryButtonColor?: string;
        retryButtonFontFamily?: string;
        retryButtonLabel?: string;
        retryButtonTextColor?: string;
        seekBackwardIconName?: string;
        seekForwardIconName?: string;
        showAdCueMarkers?: boolean;
        showAudioTrackButton?: boolean;
        showCastButton?: boolean;
        showContentRatings?: boolean;
        showFullscreenButton?: boolean;
        showProgressBar?: boolean;
        showQualityButton?: boolean;
        showRetryButton?: boolean;
        showSeekButtons?: boolean;
        showSpeedButton?: boolean;
        showSubtitleButton?: boolean;
        showTimeLabels?: boolean;
        showTitle?: boolean;
        showUpNext?: boolean;
        showVolumeButton?: boolean;
        suppressErrorOverlay?: boolean;
        upNextBackgroundColor?: string;
        upNextFontFamily?: string;
        upNextLeadSeconds?: number;
        upNextText?: string;
        upNextTextColor?: string;
        upNextTextSize?: number;
    }
    Index
    adPauseIconName? adPlayIconName? audioTrackIconName? castConnectedIconName? castIconName? customActions? errorMessages? errorTextColor? errorTextFontFamily? errorTextSize? fullscreenEnterIconName? fullscreenExitIconName? hideAllControls? pauseIconName? playIconName? retryButtonColor? retryButtonFontFamily? retryButtonLabel? retryButtonTextColor? seekBackwardIconName? seekForwardIconName? showAdCueMarkers? showAudioTrackButton? showCastButton? showContentRatings? showFullscreenButton? showProgressBar? showQualityButton? showRetryButton? showSeekButtons? showSpeedButton? showSubtitleButton? showTimeLabels? showTitle? showUpNext? showVolumeButton? suppressErrorOverlay? upNextBackgroundColor? upNextFontFamily? upNextLeadSeconds? upNextText? upNextTextColor? upNextTextSize?
    adPauseIconName?: string
    adPlayIconName?: string
    audioTrackIconName?: string
    castConnectedIconName?: string
    castIconName?: string
    customActions?: CustomActionConfig[]

    Up to 8 host icon buttons in the control chrome; taps land in onCustomAction(index).

    errorMessages?: Record<string, string>

    Replace the SDK's default error copy, keyed by numeric error code; "default" applies to unlisted codes.

    errorTextColor?: string

    0.13.1 — error-overlay message styling (hex color, sp/pt size, platform font family such as "serif").

    errorTextFontFamily?: string
    errorTextSize?: number
    fullscreenEnterIconName?: string

    Set BOTH or neither — the SDK takes the pair together.

    fullscreenExitIconName?: string
    hideAllControls?: boolean

    Hide every control — fully headless surface.

    pauseIconName?: string
    playIconName?: string

    Replace built-in control glyphs by NATIVE drawable/asset name (the icon must exist in the app's native resources).

    retryButtonColor?: string

    0.13.1 — Retry button styling.

    retryButtonFontFamily?: string
    retryButtonLabel?: string
    retryButtonTextColor?: string
    seekBackwardIconName?: string
    seekForwardIconName?: string
    showAdCueMarkers?: boolean
    showAudioTrackButton?: boolean
    showCastButton?: boolean
    showContentRatings?: boolean
    showFullscreenButton?: boolean
    showProgressBar?: boolean
    showQualityButton?: boolean
    showRetryButton?: boolean
    showSeekButtons?: boolean
    showSpeedButton?: boolean
    showSubtitleButton?: boolean
    showTimeLabels?: boolean
    showTitle?: boolean
    showUpNext?: boolean

    "Up next" countdown card in the lead window before a playlist item ends (default true). false = the queue still auto-advances, silently.

    showVolumeButton?: boolean
    suppressErrorOverlay?: boolean

    Hide the SDK's built-in error overlay entirely (onError still fires) — for hosts drawing their own error UI over the player.

    upNextBackgroundColor?: string

    Card styling (hex color, sp/pt size, platform font family).

    upNextFontFamily?: string
    upNextLeadSeconds?: number

    Seconds before the end at which the card appears (default 10, 1–60).

    upNextText?: string

    Card text template — {seconds} and {title} are substituted (default "Next in {seconds}"). Your copy, any language.

    upNextTextColor?: string
    upNextTextSize?: number

    Settings
    Member Visibility

    On This Page
    Properties