Package io.github.thoroldvix.api

Class BulkTranscriptRequest

java.lang.Object

io.github.thoroldvix.api.BulkTranscriptRequest

public class BulkTranscriptRequest
extends Object

Request object for retrieving transcripts.

Contains an API key required for the YouTube V3 API, and optionally a file path to the text file containing the authentication cookies. If cookies are not provided, the API will not be able to access age restricted videos. Also contains a flag to stop on error or continue on error. Defaults to false if not provided.

Constructor Summary

Constructors

Constructor	Description
BulkTranscriptRequest(String apiKey)
BulkTranscriptRequest(String apiKey, boolean stopOnError)

Method Summary

Modifier and Type	Method	Description
String	getApiKey()
boolean	isStopOnError()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BulkTranscriptRequest

public BulkTranscriptRequest(String apiKey,
 boolean stopOnError)

BulkTranscriptRequest

public BulkTranscriptRequest(String apiKey)

Method Details

getApiKey

public String getApiKey()

Returns:

API key for the YouTube V3 API (see Getting started)

isStopOnError

public boolean isStopOnError()

Returns:

Whether to stop if transcript retrieval fails for a video. If false, all transcripts that could not be retrieved will be skipped, otherwise an exception will be thrown on the first error.