PlatformPlugin
PlatformPlugin =
object
Defined in: packages/core/src/plugin.ts:142
A platform-specific plugin that implements data retrieval for a single streaming platform.
Precondition
Section titled “Precondition”Each plugin instance is bound to a single platform
Postcondition
Section titled “Postcondition”All returned data conforms to the unified Content/Channel types
Properties
Section titled “Properties”capabilities
Section titled “capabilities”
readonlycapabilities:PluginCapabilities
Defined in: packages/core/src/plugin.ts:150
Plugin capability metadata.
readonlyname:string
Defined in: packages/core/src/plugin.ts:144
Platform identifier (e.g., “youtube”, “twitch”, “twitcasting”).
readonlyrest:RestManager
Defined in: packages/core/src/plugin.ts:147
The underlying RestManager for this plugin.
Methods
Section titled “Methods”batchGetBroadcasts()?
Section titled “batchGetBroadcasts()?”
optionalbatchGetBroadcasts(channelIds):Promise<BatchResult<Broadcast[]>>
Defined in: packages/core/src/plugin.ts:183
Batch-retrieve broadcasts by channel IDs (platform-specific).
Parameters
Section titled “Parameters”channelIds
Section titled “channelIds”string[]
Returns
Section titled “Returns”Promise<BatchResult<Broadcast[]>>
batchGetChannels()?
Section titled “batchGetChannels()?”
optionalbatchGetChannels(ids):Promise<BatchResult<Channel>>
Defined in: packages/core/src/plugin.ts:195
Batch-retrieve channels by IDs (platform-specific).
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<BatchResult<Channel>>
batchGetClips()?
Section titled “batchGetClips()?”
optionalbatchGetClips(ids):Promise<BatchResult<Clip>>
Defined in: packages/core/src/plugin.ts:192
Batch-retrieve clips by IDs (platform-specific).
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<BatchResult<Clip>>
batchGetContents()?
Section titled “batchGetContents()?”
optionalbatchGetContents(ids):Promise<BatchResult<Content>>
Defined in: packages/core/src/plugin.ts:180
Batch-retrieve content by IDs (platform-specific).
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<BatchResult<Content>>
getChannel()
Section titled “getChannel()”getChannel(
id):Promise<Channel>
Defined in: packages/core/src/plugin.ts:163
Retrieve channel information by ID.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Channel>
getContent()
Section titled “getContent()”getContent(
id):Promise<Content>
Defined in: packages/core/src/plugin.ts:160
Retrieve content (broadcast or archive) by ID.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Content>
listArchives()
Section titled “listArchives()”listArchives(
channelId,cursor?,pageSize?,options?):Promise<Page<Archive>>
Defined in: packages/core/src/plugin.ts:169
List archives for a channel with cursor-based pagination.
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
cursor?
Section titled “cursor?”string
pageSize?
Section titled “pageSize?”number
options?
Section titled “options?”Returns
Section titled “Returns”listBroadcasts()
Section titled “listBroadcasts()”listBroadcasts(
channelId):Promise<Broadcast[]>
Defined in: packages/core/src/plugin.ts:166
List currently active broadcasts for a channel.
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
Returns
Section titled “Returns”Promise<Broadcast[]>
listClips()?
Section titled “listClips()?”
optionallistClips(channelId,options?):Promise<Page<Clip>>
Defined in: packages/core/src/plugin.ts:189
List clips for a channel (platform-specific).
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
options?
Section titled “options?”Returns
Section titled “Returns”match()
Section titled “match()”match(
url):ResolvedUrl|null
Defined in: packages/core/src/plugin.ts:157
Test whether a URL belongs to this platform. Returns a ResolvedUrl if matched, or null if not. No network calls.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ResolvedUrl | null
resolveArchive()?
Section titled “resolveArchive()?”
optionalresolveArchive(live):Promise<Archive|null>
Defined in: packages/core/src/plugin.ts:177
Resolve the archive for a broadcast (platform-specific).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Archive | null>
search()?
Section titled “search()?”Defined in: packages/core/src/plugin.ts:186
Search for content (platform-specific).