API
Methods
oembed
Type signature
oembed: (linkUrl: string, options?: Option) => Promise<OEmbedInterface>;
Description:
Fetches oembed metadata of provided Loom URL.
Arguments:
| Key | Description |
|---|---|
linkUrl | Loom URL string |
options | See Option |
Response:
An OEmbedInterface object wrapped in a Promise.
Example:
Input:
Output:
gifEmbed
Type signature
gifEmbed: (linkUrl: string) => Promise<string>;
Description:
Fetches gifEmbed with the embed code of provided Loom URL.
Arguments:
| Key | Description |
|---|---|
linkUrl | Loom URL string |
Response:
A string where Loom URL links are replaced with embed HTML.
Example:
Input:
Output:
linkReplace
Type signature
linkReplace: (selector?: string, options?: Option, target?: Document) => void;
Description:
Replaces Loom links with the embedded video at nodes matching the selector.
Arguments:
| Key | Description |
|---|---|
selector | Wrapping selector which contains Loom link |
options | See Option |
target | Wrapping node to target, defaults to Document |
Response:
Void.
Example:
Loom Video Link
Click “Expand” below to auto-expand the link above.
textReplace
Type signature
textReplace: (textString: string, options?: Option) => Promise<string>;
Description
Find and replaces Loom URLs with the embed code in a given string.
Arguments
| Key | Description |
|---|---|
textString | String which contains Loom URL links that should be replaced with embed HTML |
options | See Option |
Reponse:
A string where Loom URL links are replaced with embed HTML.
Example:
Input:
Output:
Types
OEmbedInterface
Type signature
interface OEmbedInterface {
type: 'video';
html: string;
title: string;
height: number | null;
width: number | null;
provider_name: 'Loom';
provider_url: string;
thumbnail_height: number;
thumbnail_width: number;
thumbnail_url: string;
duration: number;
}
Description:
The object returned from the oembed method.
Properties:
| Key | Description |
|---|---|
type | 'video' |
html | Stringified HTML of the video embed |
height | Height of the video in pixels |
width | Width of the video in pixels |
provider_name | 'Loom' |
provider_url | URL of provider |
thumbnail_height | Height of the thumbnail in pixels |
thumbnail_width | Width of the thumbnail in pixels |
thumbnail_url | Thumbnail playback URL |
duration | Duration of video in seconds |
Option
Type signature
interface Option {
width?: number;
height?: number;
gifThumbnail?: boolean;
}
Description:
The width and height defines the max width and height of the embed player in pixels.
gifThumbnail changes the video thumbnail to a gif from a jpeg if set to true.
Properties:
| Key | Description |
|---|---|
width | The max width of the embed player in pixels |
height | The max height of the embed player in pixels |
gifThumbnail | Returns a gif thumbnail for the embed player if set to true, otherwise default is jpeg |