Overview
Properties
- allowedConfigUrls
- allowedPanelUrls
- authorName
- bitsEnabled
- componentAspectHeight
- componentAspectRatioX
- componentAspectRatioY
- componentAspectWidth
- componentAutoScales
- componentCanLinkExternalContent
- componentScalePixels
- componentSize
- componentTargetHeight
- componentViewerUrl
- componentZoom
- componentZoomPixels
- configCanLinkExternalContent
- configurationLocation
- configViewerUrl
- description
- hasChatSupport
- iconUrl
- id
- installable
- mobileViewerUrl
- name
- overlayCanLinkExternalContent
- overlayViewerUrl
- panelCanLinkExternalContent
- panelHeight
- panelViewerUrl
- privacyPolicyUrl
- requestsIdentityLink
- screenshotUrls
- state
- subscriptionsSupportLevel
- summary
- supportEmail
- tosUrl
- version
- viewerSummery
Methods
Properties
componentAspectHeight
Type: number | null
The aspect height of the extension's component view.
If the extension does not have a component view, this is null.
componentAspectRatioX
Type: number | null
The horizontal aspect ratio of the extension's component view.
If the extension does not have a component view, this is null.
componentAspectRatioY
Type: number | null
The vertical aspect ratio of the extension's component view.
If the extension does not have a component view, this is null.
componentAspectWidth
Type: number | null
The aspect width of the extension's component view.
If the extension does not have a component view, this is null.
componentAutoScales
Value: false | true | null
Whether the extension's component view should automatically scale.
If the extension does not have a component view, this is null.
componentCanLinkExternalContent
Value: false | true | null
Whether the extension can link to external content from its component view.
If the extension does not have a component view, this is null.
componentScalePixels
Type: number | null
The base width of the extension's component view to use for scaling.
If the extension does not have a component view, this is null.
componentSize
Type: number | null
The size of the extension's component view.
If the extension does not have a component view, this is null.
componentTargetHeight
Type: number | null
The target height of the extension's component view.
If the extension does not have a component view, this is null.
componentViewerUrl
Type: string | null
The URL shown to the viewer when the extension is shown as a video component.
If the extension does not have a component view, this is null.
componentZoom
Value: false | true | null
Whether zooming is enabled for the extension's component view.
If the extension does not have a component view, this is null.
componentZoomPixels
Type: number | null
The zoom pixels of the extension's component view.
If the extension does not have a component view, this is null.
configCanLinkExternalContent
Value: false | true | null
Whether the extension can link to external content from its config view.
If the extension does not have a config view, this is null.
configurationLocation
Type: HelixExtensionConfigurationLocation
The location of the extension's configuration.
configViewerUrl
Type: string | null
The URL shown to the viewer when the extension's configuration page is shown.
If the extension does not have a config view, this is null.
mobileViewerUrl
Type: string | null
The URL shown when a viewer opens the extension on a mobile device.
If the extension does not have a mobile view, this is null.
overlayCanLinkExternalContent
Value: false | true | null
Whether the extension can link to external content from its overlay view.
If the extension does not have a overlay view, this is null.
overlayViewerUrl
Type: string | null
The URL shown to the viewer when the extension is shown as a video overlay.
If the extension does not have a overlay view, this is null.
panelCanLinkExternalContent
Value: false | true | null
Whether the extension can link to external content from its panel view.
If the extension does not have a panel view, this is null.
panelHeight
Type: number | null
The height of the extension panel.
If the extension does not have a panel view, this is null.
panelViewerUrl
Type: string | null
The URL shown to the viewer when the extension is shown as a panel.
If the extension does not have a panel view, this is null.
requestsIdentityLink
Type: boolean
Whether the extension requests its users to share their identity with it.
subscriptionsSupportLevel
Type: HelixExtensionSubscriptionsSupportLevel
The extension's level of support for subscriptions.