TwitchLib 3.5.3
Loading...
Searching...
No Matches
TwitchLib.Api.Helix.Videos Class Reference

Videos related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.Videos:
TwitchLib.Api.Core.ApiBase

Public Member Functions

 Videos (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
 
Task< DeleteVideosResponseDeleteVideosAsync (List< string > videoIds, string accessToken=null)
 Deletes one or more videos. Videos are past broadcasts, Highlights, or uploads. More...
 
Task< GetVideosResponseGetVideosAsync (List< string > videoIds=null, string userId=null, string gameId=null, string after=null, string before=null, int first=20, string language=null, Period period=Period.All, VideoSort sort=VideoSort.Time, VideoType type=VideoType.All, string accessToken=null)
 Gets video information by one or more video IDs, user ID, or game ID. More...
 
- Public Member Functions inherited from TwitchLib.Api.Core.ApiBase
 ApiBase (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
 
async ValueTask< string > GetAccessTokenAsync (string accessToken=null)
 

Additional Inherited Members

- Protected Member Functions inherited from TwitchLib.Api.Core.ApiBase
async Task< string > TwitchGetAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< T > TwitchGetGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< T > TwitchPatchGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< string > TwitchPatchAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< KeyValuePair< int, string > > TwitchDeleteAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< T > TwitchPostGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< T > TwitchPostGenericModelAsync< T > (string resource, ApiVersion api, RequestModel model, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< T > TwitchDeleteGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< T > TwitchPutGenericAsync< T > (string resource, ApiVersion api, string payload=null, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< string > TwitchPutAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
async Task< KeyValuePair< int, string > > TwitchPostAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
 
Task PutBytesAsync (string url, byte[] payload)
 
async Task< T > GetGenericAsync< T > (string url, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, ApiVersion api=ApiVersion.Helix, string clientId=null)
 
- Protected Attributes inherited from TwitchLib.Api.Core.ApiBase
readonly IApiSettings Settings
 

Detailed Description

Videos related APIs

Constructor & Destructor Documentation

◆ Videos()

TwitchLib.Api.Helix.Videos.Videos ( IApiSettings  settings,
IRateLimiter  rateLimiter,
IHttpCallHandler  http 
)

Member Function Documentation

◆ DeleteVideosAsync()

Task< DeleteVideosResponse > TwitchLib.Api.Helix.Videos.DeleteVideosAsync ( List< string >  videoIds,
string  accessToken = null 
)

Deletes one or more videos. Videos are past broadcasts, Highlights, or uploads.

Invalid Video IDs will be ignored (i.e. IDs provided that do not have a video associated with it).

If the OAuth user token does not have permission to delete even one of the valid Video IDs, no videos will be deleted and the response will return a 401.

Required scope: channel:manage:videos

Parameters
videoIdsID of the video(s) to be deleted. Maximum: 5
accessTokenoptional access token to override the use of the stored one in the TwitchAPI instance
Returns
Exceptions
BadParameterException

◆ GetVideosAsync()

Task< GetVideosResponse > TwitchLib.Api.Helix.Videos.GetVideosAsync ( List< string >  videoIds = null,
string  userId = null,
string  gameId = null,
string  after = null,
string  before = null,
int  first = 20,
string  language = null,
Period  period = Period.All,
VideoSort  sort = VideoSort.Time,
VideoType  type = VideoType.All,
string  accessToken = null 
)

Gets video information by one or more video IDs, user ID, or game ID.

For lookup by user or game, several filters are available that can be specified as query parameters.

Each request must specify one or more videoIds, one userId, or one gameId.

Parameters
videoIdsIDs of the videos to query. Maximum: 100.
userIdID of the user who owns the video.
gameIdID of the game the video is of.
afterCursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
beforeCursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
firstNumber of values to be returned when getting videos by user or game ID. Maximum: 100. Default: 20.
languageLanguage of the video being queried. A language value must be either the ISO 639-1 two-letter code for a supported stream language or “other”.
periodPeriod during which the video was created.
sortSort order of the videos.
typeType of video.
accessTokenoptional access token to override the use of the stored one in the TwitchAPI instance
Returns
Exceptions
BadParameterException
ArgumentOutOfRangeException

The documentation for this class was generated from the following file: