target.apidocs.com.google.api.services.youtube.YouTube.LiveBroadcasts.html Maven / Gradle / Ivy

Go to download







YouTube.LiveBroadcasts (YouTube Data API v3-rev20200213-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.youtube
Class YouTube.LiveBroadcasts



java.lang.Object


com.google.api.services.youtube.YouTube.LiveBroadcasts







Enclosing class:
YouTube




public class YouTube.LiveBroadcasts
extends Object
The "liveBroadcasts" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
YouTube.LiveBroadcasts.Bind 


class 
YouTube.LiveBroadcasts.Control 


class 
YouTube.LiveBroadcasts.Delete 


class 
YouTube.LiveBroadcasts.Insert 


class 
YouTube.LiveBroadcasts.List 


class 
YouTube.LiveBroadcasts.Transition 


class 
YouTube.LiveBroadcasts.Update 









Constructor Summary

Constructors 

Constructor and Description


LiveBroadcasts() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


YouTube.LiveBroadcasts.Bind
bind(String id,
    String part)
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a
 stream.



YouTube.LiveBroadcasts.Control
control(String id,
       String part)
Controls the settings for a slate that can be displayed in the broadcast stream.



YouTube.LiveBroadcasts.Delete
delete(String id)
Deletes a broadcast.



YouTube.LiveBroadcasts.Insert
insert(String part,
      LiveBroadcast content)
Creates a broadcast.



YouTube.LiveBroadcasts.List
list(String part)
Returns a list of YouTube broadcasts that match the API request parameters.



YouTube.LiveBroadcasts.Transition
transition(String broadcastStatus,
          String id,
          String part)
Changes the status of a YouTube live broadcast and initiates any processes associated with the
 new status.



YouTube.LiveBroadcasts.Update
update(String part,
      LiveBroadcast content)
Updates a broadcast.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





LiveBroadcasts
public LiveBroadcasts()









Method Detail





bind
public YouTube.LiveBroadcasts.Bind bind(String id,
                                        String part)
                                 throws IOException
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a
 stream. A broadcast can only be bound to one video stream, though a video stream may be bound to
 more than one broadcast.

 Create a request for the method "liveBroadcasts.bind".

 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 parameter specifies the unique ID of the broadcast that is being bound to a video stream.
part - The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties
        that the API response will include. The part names that you can include in the parameter
        value are id, snippet, contentDetails, and status.
Returns:
the request
Throws:
IOException








control
public YouTube.LiveBroadcasts.Control control(String id,
                                              String part)
                                       throws IOException
Controls the settings for a slate that can be displayed in the broadcast stream.

 Create a request for the method "liveBroadcasts.control".

 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 parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in
        which the slate is being updated.
part - The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties
        that the API response will include. The part names that you can include in the parameter
        value are id, snippet, contentDetails, and status.
Returns:
the request
Throws:
IOException








delete
public YouTube.LiveBroadcasts.Delete delete(String id)
                                     throws IOException
Deletes a broadcast.

 Create a request for the method "liveBroadcasts.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 - The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted.
Returns:
the request
Throws:
IOException








insert
public YouTube.LiveBroadcasts.Insert insert(String part,
                                            LiveBroadcast content)
                                     throws IOException
Creates a broadcast.

 Create a request for the method "liveBroadcasts.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 serves two purposes in this operation. It identifies the properties that the
        write operation will set as well as the properties that the API response will include.
    The
        part properties that you can include in the parameter value are id, snippet,
        contentDetails, and status.
content - the LiveBroadcast
Returns:
the request
Throws:
IOException








list
public YouTube.LiveBroadcasts.List list(String part)
                                 throws IOException
Returns a list of YouTube broadcasts that match the API request parameters.

 Create a request for the method "liveBroadcasts.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 liveBroadcast resource properties
        that the API response will include. The part names that you can include in the parameter
        value are id, snippet, contentDetails, and status.
Returns:
the request
Throws:
IOException








transition
public YouTube.LiveBroadcasts.Transition transition(String broadcastStatus,
                                                    String id,
                                                    String part)
                                             throws IOException
Changes the status of a YouTube live broadcast and initiates any processes associated with the
 new status. For example, when you transition a broadcast's status to testing, YouTube starts to
 transmit video to that broadcast's monitor stream. Before calling this method, you should confirm
 that the value of the status.streamStatus property for the stream bound to your broadcast is
 active.

 Create a request for the method "liveBroadcasts.transition".

 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:
broadcastStatus - The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to
        transition a broadcast to either the testing or live state, the status.streamStatus must
        be active for the stream that the broadcast is bound to.
id - The id parameter specifies the unique ID of the broadcast that is transitioning to another status.
part - The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties
        that the API response will include. The part names that you can include in the parameter
        value are id, snippet, contentDetails, and status.
Returns:
the request
Throws:
IOException








update
public YouTube.LiveBroadcasts.Update update(String part,
                                            LiveBroadcast content)
                                     throws IOException
Updates a broadcast. For example, you could modify the broadcast settings defined in the
 liveBroadcast resource's contentDetails object.

 Create a request for the method "liveBroadcasts.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 serves two purposes in this operation. It identifies the properties that the
        write operation will set as well as the properties that the API response will include.
    The
        part properties that you can include in the parameter value are id, snippet,
        contentDetails, and status.
    Note that this method will override the existing values for
        all of the mutable properties that are contained in any parts that the parameter value
        specifies. For example, a broadcast's privacy status is defined in the status part. As
        such, if your request is updating a private or unlisted broadcast, and the request's part
        parameter value includes the status part, the broadcast's privacy setting will be updated
        to whatever value the request body specifies. If the request body does not specify a
        value, the existing privacy setting will be removed and the broadcast will revert to the
        default privacy setting.
content - the LiveBroadcast
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`YouTube.LiveBroadcasts.Bind`
`class`	`YouTube.LiveBroadcasts.Control`
`class`	`YouTube.LiveBroadcasts.Delete`
`class`	`YouTube.LiveBroadcasts.Insert`
`class`	`YouTube.LiveBroadcasts.List`
`class`	`YouTube.LiveBroadcasts.Transition`
`class`	`YouTube.LiveBroadcasts.Update`

Modifier and Type	Method and Description
`YouTube.LiveBroadcasts.Bind`	`bind(String id, String part)` Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream.
`YouTube.LiveBroadcasts.Control`	`control(String id, String part)` Controls the settings for a slate that can be displayed in the broadcast stream.
`YouTube.LiveBroadcasts.Delete`	`delete(String id)` Deletes a broadcast.
`YouTube.LiveBroadcasts.Insert`	`insert(String part, LiveBroadcast content)` Creates a broadcast.
`YouTube.LiveBroadcasts.List`	`list(String part)` Returns a list of YouTube broadcasts that match the API request parameters.
`YouTube.LiveBroadcasts.Transition`	`transition(String broadcastStatus, String id, String part)` Changes the status of a YouTube live broadcast and initiates any processes associated with the new status.
`YouTube.LiveBroadcasts.Update`	`update(String part, LiveBroadcast content)` Updates a broadcast.