OGPlayer Web SDK
    Preparing search index...

    Interface OGVerticalFeedConfig

    All knobs,.

    interface OGVerticalFeedConfig {
        contentFit: VerticalFeedContentFit;
        errorMessageProvider: ((error: OGPlayerError) => string | null) | null;
        keepBehind: number;
        licenseKey: string | null;
        loopItems: boolean;
        maxItemDurationSeconds: number;
        paginationThreshold: number;
        playIconSvg: string | null;
        preloadAhead: number;
        progressBarColor: string;
        progressBarThickness: number;
        progressBarTrackColor: string;
        showProgressBar: boolean;
        showSponsoredBadge: boolean;
        showSubtitle: boolean;
        showTitle: boolean;
        strings?: Partial<OGStrings>;
        subtitleTextSize: number;
        textBandColor: string;
        textBandFraction: number;
        textBandTopMargin: number;
        textFontFamily: string | null;
        titleTextSize: number;
    }
    Index
    contentFit errorMessageProvider keepBehind licenseKey loopItems maxItemDurationSeconds paginationThreshold playIconSvg preloadAhead progressBarColor progressBarThickness progressBarTrackColor showProgressBar showSponsoredBadge showSubtitle showTitle strings? subtitleTextSize textBandColor textBandFraction textBandTopMargin textFontFamily titleTextSize
    contentFit: VerticalFeedContentFit
    errorMessageProvider: ((error: OGPlayerError) => string | null) | null

    Replace the SDK's default error copy (level 2 of error handling).

    keepBehind: number
    licenseKey: string | null
    loopItems: boolean
    maxItemDurationSeconds: number

    Items longer than this are skipped at prepare time; 0 = no limit.

    paginationThreshold: number

    onNearEnd fires when this many items remain below the active one.

    playIconSvg: string | null

    Inline SVG replacing the center play glyph.

    preloadAhead: number
    progressBarColor: string
    progressBarThickness: number

    Hairline thickness in px.

    progressBarTrackColor: string
    showProgressBar: boolean
    showSponsoredBadge: boolean
    showSubtitle: boolean
    showTitle: boolean
    strings?: Partial<OGStrings>

    The feed's words — a partial map merged over English, the same keys as OGUIConfig.strings. The feed reads play, retry, errorGeneric and sponsored; errorMessageProvider still wins where it returns text.

    subtitleTextSize: number

    px

    textBandColor: string

    CSS color of the split-text band background.

    textBandFraction: number

    Fraction of the page height the text band owns (0.15–0.5).

    textBandTopMargin: number

    px between the band's top edge and its text.

    textFontFamily: string | null

    CSS font-family for title/subtitle/band text; null = system.

    titleTextSize: number

    px

    Settings
    Member Visibility

    On This Page
    Properties