Loom Types

• GetLoomMetadataAction

  Defines an event that retrieves the metadata for a loom video.

  Members

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • sharedUrl string

    The shared URL of the loom video that the metadata should be retrieved for.

  • taskId (string | number)

    The ID of the async task.

  • type "get_loom_metadata"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

• LoomVideo

  Defines an interface that contains information for a loom video.

  Members

  • duration string

    The duration of the video in seconds.

  • embedUrl string

    The URL that should be used for embedding the video.

  • height number

    The height of the video in pixels.

  • id string

    The ID of the loom video.

  • sharedUrl string

    The URL that should be used for sharing the video.

  • thumbnailHeight number

    The height of the thumbnail in pixels.

  • thumbnailUrl string

    The URL of the thumbnail for the video.

  • thumbnailWidth number

    The width of the thumbnail in pixels.

  • title string

    The title of the loom video.

  • width number

    The width of the video in pixels.

• LoomVideoEmbedMetadata

  Defines an interface that contains embed metadata for a loom video.

  Members

  • duration number

    The duration of the video in seconds.

  • height number

    The height of the video in pixels.

  • html string

    The HTML that can be used to embed the video.

  • thumbnailHeight number

    The height of the thumbnail image in pixels.

  • thumbnailWidth number

    The width of the thumbnail image in pixels.

  • thumnailUrl string

    The URL of the thumbnail image for the video.

  • width number

    The width of the video in pixels.

• RecordLoomAction

  Defines an event that requests that a loom video be recorded.

  Members

  • options RecordLoomOptions

    The options for the loom.

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • taskId (string | number)

    The ID of the async task.

  • type "record_loom"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

• RecordLoomOptions

  Defines a set of options that can be used when recording a loom.

  Members

  • publicAppId? string

    The public ID of the loom app.

  • recordName? string

    The name of the record that the loom recording is for.

• WatchLoomAction

  Defines an event that requests that a loom video be displayed to the user.

  Members

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • sharedUrl string

    The shared URL of the loom video that should be watched.

  • taskId (string | number)

    The ID of the async task.

  • type "watch_loom"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.