Interface MediaPickerTextureProvider

Base class for Texture Providers based on selectable media.

interface MediaPickerTextureProvider {
    autoShowMediaPicker: boolean;
    cropFace: boolean;
    faceImageControl: FaceTextureProvider;
    imageControl: TextureProvider;
    isContentReady: boolean;
    isFaceImagePickingEnabled: boolean;
    isImagePickingEnabled: boolean;
    isVideoPickingEnabled: boolean;
    videoControl: VideoTextureProvider;
    getAspect(): number;
    getHeight(): number;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    getWidth(): number;
    hideMediaPicker(): void;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    setFaceMeshReadyCallback(callback: (() => void)): void;
    setFilePickedCallback(callback: (() => void)): void;
    showMediaPicker(): void;
}

Hierarchy (view full)

Properties

autoShowMediaPicker cropFace faceImageControl imageControl isContentReady isFaceImagePickingEnabled isImagePickingEnabled isVideoPickingEnabled videoControl

Methods

getAspect getHeight getLoadStatus getTypeName getWidth hideMediaPicker isOfType isSame setFaceMeshReadyCallback setFilePickedCallback showMediaPicker

Properties

autoShowMediaPicker

autoShowMediaPicker: boolean

If set to true, MediaPickerTextureProvider will request media picker UI automatically during loading.

cropFace

cropFace: boolean

If set to true, MediaPickerTextureProvider will provide a proper texture transform for image with face(s), that will "zoom" UVs to the first found face on the image.

faceImageControl

faceImageControl: FaceTextureProvider

Returns underlying TextureProvider for the last selected media file. If the last media file was not image with at least one face, null is returned.

ReadonlyimageControl

imageControl: TextureProvider

Returns underlying TextureProvider for the last selected media file. If the last media file was not image, null is returned.

ReadonlyisContentReady

isContentReady: boolean

Returns true if an image is selected, or a video file has been loaded and is ready for decoding, false otherwise.

isFaceImagePickingEnabled

isFaceImagePickingEnabled: boolean

MediaPickerTextureProvider will allow users to select only images with detected faces through media picker UI. See also "cropFace" option.

isImagePickingEnabled

isImagePickingEnabled: boolean

MediaPickerTextureProvider will allow users to select all images files through media picker UI.

isVideoPickingEnabled

isVideoPickingEnabled: boolean

MediaPickerTextureProvider will allow users to select video files through media picker UI.

ReadonlyvideoControl

videoControl: VideoTextureProvider

Returns underlying VideoTextureProvider for the last selected media file. If the last media file was not video, null is returned.

Methods

getAspect

  • getAspect(): number

  • Returns the texture's aspect ratio, which is calculated as width / height.

    Returns number

getHeight

getLoadStatus

getTypeName

getWidth

  • getWidth(): number

  • Returns the width of the texture in pixels.

    Returns number

hideMediaPicker

  • hideMediaPicker(): void

  • Requests SDK to hide media picking UI.

    Returns void

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

setFaceMeshReadyCallback

  • setFaceMeshReadyCallback(callback): void

  • Requests face mesh and sets a callback to fire when it's ready.

    Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

setFilePickedCallback

  • setFilePickedCallback(callback): void

  • Sets a callback to fire when a file is picked through media picking UI.

    Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

showMediaPicker

  • showMediaPicker(): void

  • Requests SDK to show media picking UI.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods