TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

Classes

ApiReportedRequestChatMessageDroppedErrorConfigErrorHelixAdScheduleHelixBanHelixBanUserHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixBlockedTermHelixChannelHelixChannelEditorHelixChannelEmoteHelixChannelFollowerHelixChannelReferenceHelixChannelSearchResultHelixCharityCampaignHelixCharityCampaignAmountHelixCharityCampaignDonationHelixChatBadgeSetHelixChatBadgeVersionHelixChatChatterHelixChatSettingsHelixCheermoteListHelixClipHelixContentClassificationLabelHelixCustomRewardHelixCustomRewardRedemptionHelixDropsEntitlementHelixEmoteHelixEmoteFromSetHelixEventSubConduitHelixEventSubConduitShardHelixEventSubSubscriptionHelixExtensionBitsProductHelixExtensionTransactionHelixFollowHelixFollowedChannelHelixGameHelixGoalHelixGoalApiHelixHypeTrainHelixHypeTrainAllTimeHighHelixHypeTrainContributionHelixHypeTrainSharedParticipantHelixHypeTrainStatusHelixInstalledExtensionHelixInstalledExtensionListHelixModeratedChannelHelixModeratorHelixPaginatedEventSubSubscriptionsRequestHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPaginatedSubscriptionsRequestHelixPollHelixPollChoiceHelixPredictionHelixPredictionOutcomeHelixPredictorHelixPrivilegedChatSettingsHelixPrivilegedUserHelixRaidHelixScheduleHelixScheduleSegmentHelixSentChatMessageHelixSharedChatSessionHelixSharedChatSessionParticipantHelixShieldModeStatusHelixStreamHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixTeamHelixTeamWithUsersHelixUnbanRequestHelixUserHelixUserBlockHelixUserEmoteHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoHelixWarningStreamNotLiveError

HelixClipCreateParams

Parameters for creating a clip from a live stream.

{
The broadcaster of which you want to create a clip.
channel:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

Add a delay before the clip creation that accounts for the usual delay in the viewing experience.
The duration of the clip, in seconds. The valid range is 5-60, with a precision of 0.1.
duration?: number
The title of the clip. If not given, the title of the clip will be the same as the title of the stream.
title?: string
}

Properties

channel

Type:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

The broadcaster of which you want to create a clip.

createAfterDelay

Type: ?boolean

Add a delay before the clip creation that accounts for the usual delay in the viewing experience.

duration

Type: ?number

The duration of the clip, in seconds. The valid range is 5-60, with a precision of 0.1.

If not given, the duration of the clip will be 30 seconds.

title

Type: ?string

The title of the clip. If not given, the title of the clip will be the same as the title of the stream.