Hosanna UI API v1.30.2-next
    Preparing search index...

    Interface ISGNYBPluginRokuVideo

    ISGNYBPluginRokuVideo extends ISGNYBPluginGeneric to include properties specific to Roku video plugins. It adds support for task state and task control.

    interface ISGNYBPluginRokuVideo {
        adevent?: JsonData;
        beatTimerControl?: string;
        boundView?: unknown;
        change?: { [key: string]: any };
        control?: TaskControl;
        div?: HTMLDivElement;
        event?: JsonData;
        focusable?: boolean;
        focusedChild?: ISGNNode;
        functionName?: string;
        id: string;
        imaadevent?: JsonData;
        logging?: boolean;
        monitoring?: boolean;
        options?: JsonData;
        pingTime?: number;
        productAnalytics?: JsonData;
        session?: JsonData;
        state?: string;
        taskState?: string;
        updateplayer?: JsonData;
        videoplayer?: ISGNNode;
        addField(fieldName: string, type: string, alwayNotify: boolean): boolean;
        addFields(fields: any): boolean;
        AddReplace(key: string, value: any): any;
        ancestorBoundingRect(
            ancestor: undefined | null | ISGROSGNode,
        ): I2DRectangle;
        ancestorSubBoundingRect(
            itemnumber: string,
            ancestor: ISGROSGNode,
        ): I2DRectangle;
        Append(aa: any): any;
        appendChild(child: ISGNNode): boolean;
        appendChildren(child_nodes: any): boolean;
        boundingRect(): I2DRectangle;
        CallFunc(funcName: string, ...args: unknown[]): unknown;
        Clear(): any;
        clone(isDeepCopy: boolean): any;
        Count(): number;
        createChild<T extends ISGNNode = ISGNNode>(nodeType: string): T;
        createChildren<T extends ISGNNode = ISGNNode>(
            num_children: number,
            subtype: string,
        ): T[];
        Delete(key: string): boolean;
        DoesExist(key: string): boolean;
        findNode(name: string): any;
        getAll(): any;
        getAllMeta(): any;
        getChild(index: number): any;
        getChildCount(): number;
        getChildren(num_children: number, index: number): any;
        getField<T = unknown>(fieldName: string): T;
        getFields(): JsonData;
        getFieldType(fieldName: string): string;
        getFieldTypes(): string[];
        getHttpAgent(): any;
        getParent(): undefined | ISGNNode;
        getRoots(): any;
        getRootsMeta(): any;
        getScene(): ISGNNode;
        hasField(fieldName: string): boolean;
        hasFocus(): boolean;
        insertChild(child: ISGNNode, index: number): boolean;
        insertChildren(child_nodes: any, index: number): boolean;
        isInFocusChain(): boolean;
        isSameNode(node: any): boolean;
        isSubtype(nodeType: string): boolean;
        Items(): any;
        Keys(): string[];
        localBoundingRect(): I2DRectangle;
        localSubBoundingRect(itemnumber: string): I2DRectangle;
        Lookup(key: string): any;
        LookupCI(key: string): any;
        mount(): void;
        observeField(
            fieldName: string,
            functionName: Function,
            infoFields?: string[],
        ): boolean;
        observeField(
            fieldName: string,
            functionName: string,
            infoFields?: string[],
        ): boolean;
        observeField(fieldName: string, port: any, infoFields?: string[]): boolean;
        observeFieldScoped(
            fieldName: string,
            functionName: string,
            infoFields?: string[],
        ): boolean;
        observeFieldScoped(
            fieldName: string,
            functionName: Function,
            infoFields?: string[],
        ): boolean;
        observeFieldScoped(
            fieldName: string,
            port: any,
            infoFields?: string[],
        ): boolean;
        parentSubtype(nodeType: string): string;
        queueFields(queueNode: boolean): boolean;
        removeChild(child: ISGNNode): boolean;
        removeChildIndex(index: number): boolean;
        removeChildren(child_nodes: ISGNNode[]): boolean;
        removeChildrenIndex(num_children: number, index: number): boolean;
        removeField(fieldName: string): boolean;
        removeFields(fieldNames: any): boolean;
        render(): void;
        reparent(newParent: ISGNNode, adjustTransform: boolean): boolean;
        replaceChild(newChild: ISGNNode, index: number): boolean;
        replaceChildren(child_nodes: any, index: number): boolean;
        sceneBoundingRect(): I2DRectangle;
        sceneSubBoundingRect(itemnumber: string): I2DRectangle;
        setField(fieldName: string, value: any): boolean;
        setFields(fields: any): boolean;
        setFocus(on: boolean): boolean;
        setHttpAgent(HTTP_agent: any): boolean;
        SetModeCaseSensitive(): any;
        showDebugBounds(show: boolean): void;
        signalBeacon(beacon: string): number;
        subBoundingRect(itemnumber: string): I2DRectangle;
        subtype(): string;
        threadinfo(): any;
        unmount(): void;
        unobserveField(fieldName: string): boolean;
        unobserveFieldScoped(fieldName: string): boolean;
        update(fields: any, addFields?: boolean): any;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adevent? beatTimerControl? boundView? change? control? div? event? focusable? focusedChild? functionName? id imaadevent? logging? monitoring? options? pingTime? productAnalytics? session? state? taskState? updateplayer? videoplayer?

    Methods

    addField addFields AddReplace ancestorBoundingRect ancestorSubBoundingRect Append appendChild appendChildren boundingRect CallFunc Clear clone Count createChild createChildren Delete DoesExist findNode getAll getAllMeta getChild getChildCount getChildren getField getFields getFieldType getFieldTypes getHttpAgent getParent getRoots getRootsMeta getScene hasField hasFocus insertChild insertChildren isInFocusChain isSameNode isSubtype Items Keys localBoundingRect localSubBoundingRect Lookup LookupCI mount observeField observeFieldScoped parentSubtype queueFields removeChild removeChildIndex removeChildren removeChildrenIndex removeField removeFields render reparent replaceChild replaceChildren sceneBoundingRect sceneSubBoundingRect setField setFields setFocus setHttpAgent SetModeCaseSensitive showDebugBounds signalBeacon subBoundingRect subtype threadinfo unmount unobserveField unobserveFieldScoped update

    Properties

    adevent?: JsonData

    Data for handling ad events.

    beatTimerControl?: string

    Control mechanism for the beat timer (start/stop).

    boundView?: unknown
    change?: { [key: string]: any }

    Change object

    control?: TaskControl

    The control mechanism for the task.

    div?: HTMLDivElement
    event?: JsonData

    The event data associated with the plugin.

    focusable?: boolean

    Is focusable

    focusedChild?: ISGNNode

    Focused child

    functionName?: string

    Function name to execute

    id: string

    Node ID

    imaadevent?: JsonData

    Data for handling IMA ad events.

    logging?: boolean

    Indicates whether logging is enabled for the plugin.

    monitoring?: boolean

    Indicates whether monitoring is enabled for the plugin.

    options?: JsonData

    Configuration options for the plugin.

    pingTime?: number

    The ping time interval for monitoring, in milliseconds.

    productAnalytics?: JsonData

    Data for product analytics.

    session?: JsonData

    Session data associated with the plugin.

    state?: string

    Current state

    taskState?: string

    The current state of the task.

    updateplayer?: JsonData

    Data for updating the video player.

    videoplayer?: ISGNNode

    The video player node associated with the plugin.

    Methods

    • Adds field to node

      Parameters

      • fieldName: string
      • type: string
      • alwayNotify: boolean

      Returns boolean

    • Adds or replaces a key-value pair

      Parameters

      • key: string
      • value: any

      Returns any

    • Parameters

      • funcName: string
      • ...args: unknown[]

      Returns unknown

    • Clones node

      Parameters

      • isDeepCopy: boolean

      Returns any

    • Deletes an item by key

      Parameters

      • key: string

      Returns boolean

    • Gets multiple child nodes

      Parameters

      • num_children: number
      • index: number

      Returns any

    • Gets field value

      Type Parameters

      • T = unknown

      Parameters

      • fieldName: string

      Returns T

    • Checks if field exists

      Parameters

      • fieldName: string

      Returns boolean

    • Inserts multiple child nodes at index

      Parameters

      • child_nodes: any
      • index: number

      Returns boolean

    • Checks if node is subtype

      Parameters

      • nodeType: string

      Returns boolean

    • Looks up a value by key (case insensitive)

      Parameters

      • key: string

      Returns any

    • Observes field changes

      Parameters

      • fieldName: string
      • functionName: Function
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • functionName: string
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • port: any
      • OptionalinfoFields: string[]

      Returns boolean

    • Observes field changes with scope

      Parameters

      • fieldName: string
      • functionName: string
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • functionName: Function
      • OptionalinfoFields: string[]

      Returns boolean

    • Parameters

      • fieldName: string
      • port: any
      • OptionalinfoFields: string[]

      Returns boolean

    • Queues field updates

      Parameters

      • queueNode: boolean

      Returns boolean

    • Removes multiple child nodes at index

      Parameters

      • num_children: number
      • index: number

      Returns boolean

    • Replaces multiple child nodes at index

      Parameters

      • child_nodes: any
      • index: number

      Returns boolean

    • Sets field value

      Parameters

      • fieldName: string
      • value: any

      Returns boolean

    • Gets sub-item bounding rect

      Parameters

      • itemnumber: string

      Returns I2DRectangle

    • Updates node fields

      Parameters

      • fields: any
      • OptionaladdFields: boolean

      Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectCallFuncClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate