hosanna-ui-docs - v0.9.0
    Preparing search index...

    Interface ISGNVideo

    Interface for video component.

    interface ISGNVideo {
        availableSubtitleTracks: IVideoSubtitleTrackInfo[];
        boundView: undefined | IHosannaView<ViewState>;
        bufferingStatus?: any;
        captionStyle: any;
        change?: { [key: string]: any };
        childRenderOrder?: string;
        clippingRect?: number[];
        content?: ISGNNode;
        contentIndex?: number;
        contentIsPlaylist?: boolean;
        contentUri?: string;
        control?: VideoControl;
        currentSubtitleTrack: string;
        decoderStats?: any;
        div: undefined | HTMLDivElement;
        duration?: number;
        enableDecoderStats?: boolean;
        enableRenderTracking?: boolean;
        enableTrickPlay: boolean;
        enableUI: boolean;
        errorCode?: VideoErrorCode;
        errorInfo?: any;
        errorMsg?: string;
        errorStr?: string;
        focusable?: boolean;
        focusedChild?: void;
        globalCaptionMode: VideoCaptionMode;
        height: number;
        id: string;
        inheritParentOpacity?: boolean;
        inheritParentTransform?: boolean;
        licenseStatus?: any;
        loop?: boolean;
        mediaType?: MediaType;
        mute: boolean;
        muteAudioGuide?: boolean;
        nextContentIndex?: number;
        notificationInterval: number;
        opacity: number;
        playbackActionButtonFocused?: number;
        playbackActionButtonFocusedTextColor?: sgApi.IColor;
        playbackActionButtonFocusedTextFont?: ISGROFont;
        playbackActionButtonFocusIndicatorBlendColor?: sgApi.IColor;
        playbackActionButtons?: any;
        playbackActionButtonSelected?: number;
        playbackActionButtonUnfocusedTextColor?: sgApi.IColor;
        playbackActionButtonUnfocusedTextFont?: ISGROFont;
        playStartInfo?: any;
        position?: number;
        renderPass?: number;
        renderTracking?: string;
        rotation: number;
        scale: [number, number];
        scaleRotateCenter: [number, number];
        seek?: number;
        seekMode: string;
        state?: VideoState;
        subtitleTrack: string;
        suppressCaptions: boolean;
        thumbnailTiles?: ThumbnailTiles;
        translation: [number, number];
        videoFormat?: VideoCodec;
        visible: boolean;
        width: number;
        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;
        Clear(): any;
        clone(isDeepCopy: boolean): any;
        Count(): number;
        createChild(nodeType: string): any;
        createChildren(num_children: number, subtype: string): any;
        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(fieldName: string): any;
        getFields(): any;
        getFieldType(fieldName: string): string;
        getFieldTypes(): any;
        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(): any;
        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

    availableSubtitleTracks boundView bufferingStatus? captionStyle change? childRenderOrder? clippingRect? content? contentIndex? contentIsPlaylist? contentUri? control? currentSubtitleTrack decoderStats? div duration? enableDecoderStats? enableRenderTracking? enableTrickPlay enableUI errorCode? errorInfo? errorMsg? errorStr? focusable? focusedChild? globalCaptionMode height id inheritParentOpacity? inheritParentTransform? licenseStatus? loop? mediaType? mute muteAudioGuide? nextContentIndex? notificationInterval opacity playbackActionButtonFocused? playbackActionButtonFocusedTextColor? playbackActionButtonFocusedTextFont? playbackActionButtonFocusIndicatorBlendColor? playbackActionButtons? playbackActionButtonSelected? playbackActionButtonUnfocusedTextColor? playbackActionButtonUnfocusedTextFont? playStartInfo? position? renderPass? renderTracking? rotation scale scaleRotateCenter seek? seekMode state? subtitleTrack suppressCaptions thumbnailTiles? translation videoFormat? visible width

    Methods

    addField addFields AddReplace ancestorBoundingRect ancestorSubBoundingRect Append appendChild appendChildren boundingRect 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

    availableSubtitleTracks: IVideoSubtitleTrackInfo[]

    Available subtitle tracks

    boundView: undefined | IHosannaView<ViewState>

    The view instance bound to this renderable.

    bufferingStatus?: any

    Buffering status

    captionStyle: any

    Caption style settings

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

    Change object

    childRenderOrder?: string

    Child render order

    clippingRect?: number[]

    Clipping rectangle

    Optionalcontent

    content?: ISGNNode

    Video content node

    contentIndex?: number

    Current content index

    contentIsPlaylist?: boolean

    Whether content is a playlist

    contentUri?: string

    URI of video content

    control?: VideoControl

    Video control state

    currentSubtitleTrack: string

    Currently active subtitle track

    decoderStats?: any

    Decoder statistics

    div: undefined | HTMLDivElement

    The root HTML div element for this renderable, if any.

    duration?: number

    Video duration

    enableDecoderStats?: boolean

    Whether decoder stats are enabled

    enableRenderTracking?: boolean

    Enable render tracking

    enableTrickPlay: boolean

    Whether trick play is enabled

    enableUI: boolean

    Whether video UI is enabled

    errorCode?: VideoErrorCode

    Video error code

    errorInfo?: any

    Error information

    errorMsg?: string

    Error message

    errorStr?: string

    Error string

    focusable?: boolean

    Is focusable

    focusedChild?: void

    Focused child

    globalCaptionMode: VideoCaptionMode

    Global caption display mode

    height: number

    Video height

    id: string

    Node ID

    inheritParentOpacity?: boolean

    Inherit parent opacity

    inheritParentTransform?: boolean

    Inherit parent transform

    licenseStatus?: any

    License status

    loop?: boolean

    Whether video loops

    mediaType?: MediaType

    Type of media

    mute: boolean

    Whether audio is muted

    muteAudioGuide?: boolean

    Mute audio guide

    nextContentIndex?: number

    Next content index

    notificationInterval: number

    Interval for notifications

    opacity: number

    Opacity value

    playbackActionButtonFocused?: number

    Index of focused playback action button

    playbackActionButtonFocusedTextColor?: sgApi.IColor

    Text color for focused playback button

    playbackActionButtonFocusedTextFont?: ISGROFont

    Font for focused playback button

    playbackActionButtonFocusIndicatorBlendColor?: sgApi.IColor

    Blend color for focus indicator

    playbackActionButtons?: any

    Playback action buttons

    playbackActionButtonSelected?: number

    Index of selected playback button

    playbackActionButtonUnfocusedTextColor?: sgApi.IColor

    Text color for unfocused playback button

    playbackActionButtonUnfocusedTextFont?: ISGROFont

    Font for unfocused playback button

    playStartInfo?: any

    Playback start information

    position?: number

    Current playback position

    renderPass?: number

    Render pass

    renderTracking?: string

    Render tracking

    rotation: number

    Rotation angle

    scale: [number, number]

    Scale values

    scaleRotateCenter: [number, number]

    Scale/rotate center point

    seek?: number

    Seek position

    seekMode: string
    state?: VideoState

    Video playback state

    subtitleTrack: string

    Selected subtitle track

    suppressCaptions: boolean

    Whether captions are suppressed

    thumbnailTiles?: ThumbnailTiles

    Thumbnail tiles

    translation: [number, number]

    Translation values

    videoFormat?: VideoCodec

    Video format/codec

    visible: boolean

    Visibility

    width: number

    Video width

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    availableSubtitleTracksboundViewbufferingStatuscaptionStylechangechildRenderOrderclippingRectcontentcontentIndexcontentIsPlaylistcontentUricontrolcurrentSubtitleTrackdecoderStatsdivdurationenableDecoderStatsenableRenderTrackingenableTrickPlayenableUIerrorCodeerrorInfoerrorMsgerrorStrfocusablefocusedChildglobalCaptionModeheightidinheritParentOpacityinheritParentTransformlicenseStatusloopmediaTypemutemuteAudioGuidenextContentIndexnotificationIntervalopacityplaybackActionButtonFocusedplaybackActionButtonFocusedTextColorplaybackActionButtonFocusedTextFontplaybackActionButtonFocusIndicatorBlendColorplaybackActionButtonsplaybackActionButtonSelectedplaybackActionButtonUnfocusedTextColorplaybackActionButtonUnfocusedTextFontplayStartInfopositionrenderPassrenderTrackingrotationscalescaleRotateCenterseekseekModestatesubtitleTracksuppressCaptionsthumbnailTilestranslationvideoFormatvisiblewidth
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate