From b2f25298426a6475e1776636fd4de0a6f397d486 Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Fri, 7 Apr 2023 14:44:40 -0700 Subject: Add files via upload --- com/pina/HolodexService.html | 100 +++++++++++++++++++++---------------------- 1 file changed, 50 insertions(+), 50 deletions(-) (limited to 'com/pina/HolodexService.html') diff --git a/com/pina/HolodexService.html b/com/pina/HolodexService.html index 1682214..d23242e 100644 --- a/com/pina/HolodexService.html +++ b/com/pina/HolodexService.html @@ -1,7 +1,7 @@ - + HolodexService @@ -236,23 +236,23 @@ loadScripts(document, 'script');
/api/v2/live endpoint
Parameters:
-
channel_id - the channel id
-
id - the id
-
include - the include
-
lang - the lang
-
limit - the limit
-
maxUpcomingHours - the max upcoming hours
-
mentioned_channel_id - the mentioned channel id
-
offset - the offset
-
order - the order
-
org - the org
-
paginated - the paginated
-
sort - the sort
-
status - the status
-
topic - the topic
+
channel_id - the YouTube channel id
+
id - the YouTube video id
+
include - the include parameters
+
lang - a comma separated String of languages (e.g "en,ja")
+
limit - the limit for the number of results
+
maxUpcomingHours - number of maximum hours to show upcoming videos
+
mentioned_channel_id - the mentioned channel id of a different channel (for collabs)
+
offset - the offset for the number of results
+
order - the order (asc, desc)
+
org - the organization of which to get videos for (e.g. "Hololive")
+
paginated - paginated field
+
sort - sort by returned field (e.g "start_scheduled")
+
status - filter by video status (e.g. "upcoming")
+
topic - filter by type of video (e.g "stream")
type - the type
Returns:
-
the live videos
+
a list of SimpleVideo objects
@@ -293,23 +293,23 @@ loadScripts(document, 'script');
/api/v2/video endpoint
Parameters:
-
channel_id - the channel id
-
id - the id
-
include - the include
-
lang - the lang
-
limit - the limit
-
max_upcoming_hours - the max upcoming hours
-
mentioned_channel_id - the mentioned channel id
-
offset - the offset
-
order - the order
-
org - the org
-
paginated - the paginated
-
sort - the sort
-
status - the status
-
topic - the topic
+
channel_id - the YouTube channel id
+
id - the YouTube video id
+
include - the include parameters comma seperated
+
lang - a comma separated String of languages (e.g "en,ja")
+
limit - the limit for the number of results
+
max_upcoming_hours - number of maximum hours to show upcoming videos
+
mentioned_channel_id - the mentioned channel id of a different channel (for collabs)
+
offset - the offset for the number of results
+
order - the order (asc, desc)
+
org - the organization of which to get videos for (e.g. "Hololive")
+
paginated - paginated field
+
sort - sort by returned field (e.g "start_scheduled")
+
status - filter by video status (e.g. "upcoming")
+
topic - filter by type of video (e.g "stream")
type - the type
Returns:
-
the videos
+
a list of Video objects
@@ -349,15 +349,15 @@ loadScripts(document, 'script');
/api/v2/channels/{channelID}/{type} endpoint
Parameters:
-
channelID - the channel id
-
type - the type
-
include - the include
-
lang - the lang
-
limit - the limit
-
offset - the offset
-
paginated - the paginated
+
channelID - the YouTube channel id
+
type - the type of video resource ("clips", "videos", "collabs")
+
include - the include parameters comma seperated
+
lang - a comma separated String of languages (e.g "en,ja")
+
limit - the limit for the number of results
+
offset - the offset for the number of results
+
paginated - paginated field
Returns:
-
the videos by channel id
+
list of Videos by channel id
@@ -370,7 +370,7 @@ loadScripts(document, 'script');
/api/v2/users/live endpoint
Parameters:
-
channels - the channels
+
channels - the channel ids in a comma separated String
Returns:
the videos from channels
@@ -389,9 +389,9 @@ loadScripts(document, 'script');
/api/v2/videos/{videoID} endpoint
Parameters:
-
videoID - the video id
-
lang - the lang
-
c - the c
+
videoID - the YouTube video id
+
lang - a comma separated String of languages (e.g "en,ja")
+
c - 1 will return timestamp comments for the video, 0 will not
Returns:
the video
@@ -418,13 +418,13 @@ loadScripts(document, 'script');
/api/v2/channels endpoint
Parameters:
-
limit - the limit
-
offset - the offset
-
type - the type
-
lang - the lang
-
order - the order
-
org - the org
-
sort - the sort
+
limit - the limit for the number of results
+
offset - the offset for the number of results
+
type - the type of channel (e.g "vtuber")
+
lang - a comma separated String of languages (e.g "en,ja")
+
order - ascending or descending order (e.g "asc")
+
org - filter by organization (e.g "Hololive")
+
sort - column in which data should be sorted (default is org)
Returns:
the channels
-- cgit v1.2.3