# Namespace: SDKApi
# Table of contents
# Interfaces
# Functions
# Functions
# createClip
▸ createClip(options): Promise<any>
Creates a clip.
memberof SDKApi
method createClip
example
const { SDKApi } = window['pixellot-web-sdk'];
SDKApi.createClip(options) .then(response => response.json())
# Parameters
| Name | Type | Description |
|---|---|---|
options | any | 'options' is a plain JS object to send to the server. |
# Returns
Promise<any>
# createHighlight
▸ createHighlight(options?): Promise<any>
Creates a highlight.
memberof SDKApi
method createHighlight
example
const { SDKApi } = window['pixellot-web-sdk'];
const options = { useMusic: false, clipType: 'highlight', name: 'My Clip' }
SDKApi.createHighlight(options) .then(response => response.json())
# Parameters
| Name | Type | Description |
|---|---|---|
options? | any | 'options' is a plain JS object to send to the server. |
# Returns
Promise<any>
# createTag
▸ createTag(options): Promise<any>
Create a tag for the specific event.
memberof SDKApi
method createTag
example
const { SDKApi } = window['pixellot-web-sdk'];
const options = { streamName: 'hd', mode: 'sync', videoType: 'live' };
SDKApi.createTag(options) .then(response => response.json())
# Parameters
| Name | Type | Description |
|---|---|---|
options | Record<string, unknown> | 'options' is a plain JS object to send to the server. |
# Returns
Promise<any>
# getClipById
▸ getClipById(id): Promise<any>
Gets a single clip by ID.
memberof SDKApi
method getClipById
example
const { SDKApi } = window['pixellot-web-sdk'];
const id = 'ad34627765388f';
SDKApi.getClipById(id) .then(response => response.json())
# Parameters
| Name | Type | Description |
|---|---|---|
id | string | getClipById() takes single argument - clip ID as string. |
# Returns
Promise<any>
# getClips
▸ getClips(options?): Promise<any>
Gets a list of clips.
memberof SDKApi
method getClips
example
const { SDKApi } = window['pixellot-web-sdk'];
const options = { limit: 10, offset: 0 };
SDKApi.getClips(options) .then(response => response.json())
# Parameters
| Name | Type | Description |
|---|---|---|
options | Record<string, unknown> | 'options' is a plain JS object to send to the server. |
# Returns
Promise<any>
# getTags
▸ getTags(options?): Promise<any>
Fetch tags for the specific event.
memberof SDKApi
method getTags
example
const { SDKApi } = window['pixellot-web-sdk'];
const options = { limit: 10, offset: 0, videoType: 'live' };
SDKApi.getTags(options) .then(response => response.json())
# Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
options | Object | undefined | 'options' is a plain JS object to send to the server. |
options.limit | number | 10 | tags to fetch |
options.offset | number | 0 | - |
options.videoType | string | "live" | vod or live |
# Returns
Promise<any>
# projectId
▸ Const projectId(value?): string
# Parameters
| Name | Type |
|---|---|
value? | string |
# Returns
string
# session
▸ Const session(value?): SDKApiSession
# Parameters
| Name | Type |
|---|---|
value? | SDKApiSession |