com.google.api.services.youtube

Class YouTube.Captions

java.lang.Object

com.google.api.services.youtube.YouTube.Captions

Enclosing class:

YouTube

public class YouTube.Captions
extends Object

The "captions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	YouTube.Captions.Delete
class	YouTube.Captions.Download
class	YouTube.Captions.Insert
class	YouTube.Captions.List
class	YouTube.Captions.Update

Constructor Summary

Constructors

Constructor and Description
Captions()

Method Summary

Modifier and Type	Method and Description
YouTube.Captions.Delete	delete(String id) Deletes a resource.
YouTube.Captions.Download	download(String id) Downloads a caption track.
YouTube.Captions.Insert	insert(List<String> part, Caption content) Inserts a new resource into this collection.
YouTube.Captions.Insert	insert(List<String> part, Caption content, AbstractInputStreamContent mediaContent) Inserts a new resource into this collection.
YouTube.Captions.List	list(List<String> part, String videoId) Retrieves a list of resources, possibly filtered.
YouTube.Captions.Update	update(List<String> part, Caption content) Updates an existing resource.
YouTube.Captions.Update	update(List<String> part, Caption content, AbstractInputStreamContent mediaContent) Updates an existing resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

Captions

public Captions()

Method Detail

delete

public YouTube.Captions.Delete delete(String id)
                               throws IOException

Deletes a resource. Create a request for the method "captions.delete". This request holds the parameters needed by the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

id -

Returns:

the request

Throws:

IOException

download

public YouTube.Captions.Download download(String id)
                                   throws IOException

Downloads a caption track. Create a request for the method "captions.download". This request holds the parameters needed by the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

id - The ID of the caption track to download, required for One Platform.

Returns:

the request

Throws:

IOException

insert

public YouTube.Captions.Insert insert(List<String> part,
                                      Caption content)
                               throws IOException

Inserts a new resource into this collection. Create a request for the method "captions.insert". This request holds the parameters needed by the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

part - The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

content - the Caption

Returns:

the request

Throws:

IOException

insert

public YouTube.Captions.Insert insert(List<String> part,
                                      Caption content,
                                      AbstractInputStreamContent mediaContent)
                               throws IOException

Inserts a new resource into this collection. Create a request for the method "captions.insert". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

This method should be used for uploading media content.

Parameters:

part - The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

content - the Caption media metadata or null if none

mediaContent - The media HTTP content or null if none.

Returns:

the request

Throws:

IOException - if the initialization of the request fails

list

public YouTube.Captions.List list(List<String> part,
                                  String videoId)
                           throws IOException

Retrieves a list of resources, possibly filtered. Create a request for the method "captions.list". This request holds the parameters needed by the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

part - The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

videoId - Returns the captions for the specified video.

Returns:

the request

Throws:

IOException

update

public YouTube.Captions.Update update(List<String> part,
                                      Caption content)
                               throws IOException

Updates an existing resource. Create a request for the method "captions.update". This request holds the parameters needed by the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

part - The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

content - the Caption

Returns:

the request

Throws:

IOException

update

public YouTube.Captions.Update update(List<String> part,
                                      Caption content,
                                      AbstractInputStreamContent mediaContent)
                               throws IOException

Updates an existing resource. Create a request for the method "captions.update". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

This method should be used for uploading media content.

Parameters:

part - The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

content - the Caption media metadata or null if none

mediaContent - The media HTTP content or null if none.

Returns:

the request

Throws:

IOException - if the initialization of the request fails