target.apidocs.com.google.api.services.youtube.model.VideoLiveStreamingDetails.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-youtube Show documentation

There is a newer version: v3-rev20241105-2.0.0

Show newest version







VideoLiveStreamingDetails (YouTube Data API v3 v3-rev20240417-2.0.0)











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.model
Class VideoLiveStreamingDetails



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.youtube.model.VideoLiveStreamingDetails













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class VideoLiveStreamingDetails
extends com.google.api.client.json.GenericJson
Details about the live streaming metadata.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the YouTube Data API v3. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


VideoLiveStreamingDetails() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


VideoLiveStreamingDetails
clone() 


String
getActiveLiveChatId()
The ID of the currently active live chat attached to this video.



com.google.api.client.util.DateTime
getActualEndTime()
The time that the broadcast actually ended.



com.google.api.client.util.DateTime
getActualStartTime()
The time that the broadcast actually started.



BigInteger
getConcurrentViewers()
The number of viewers currently watching the broadcast.



com.google.api.client.util.DateTime
getScheduledEndTime()
The time that the broadcast is scheduled to end.



com.google.api.client.util.DateTime
getScheduledStartTime()
The time that the broadcast is scheduled to begin.



VideoLiveStreamingDetails
set(String fieldName,
   Object value) 


VideoLiveStreamingDetails
setActiveLiveChatId(String activeLiveChatId)
The ID of the currently active live chat attached to this video.



VideoLiveStreamingDetails
setActualEndTime(com.google.api.client.util.DateTime actualEndTime)
The time that the broadcast actually ended.



VideoLiveStreamingDetails
setActualStartTime(com.google.api.client.util.DateTime actualStartTime)
The time that the broadcast actually started.



VideoLiveStreamingDetails
setConcurrentViewers(BigInteger concurrentViewers)
The number of viewers currently watching the broadcast.



VideoLiveStreamingDetails
setScheduledEndTime(com.google.api.client.util.DateTime scheduledEndTime)
The time that the broadcast is scheduled to end.



VideoLiveStreamingDetails
setScheduledStartTime(com.google.api.client.util.DateTime scheduledStartTime)
The time that the broadcast is scheduled to begin.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





VideoLiveStreamingDetails
public VideoLiveStreamingDetails()









Method Detail





getActiveLiveChatId
public String getActiveLiveChatId()
The ID of the currently active live chat attached to this video. This field is filled only if
 the video is a currently live broadcast that has live chat. Once the broadcast transitions to
 complete this field will be removed and the live chat closed down. For persistent broadcasts
 that live chat id will no longer be tied to this video but rather to the new video being
 displayed at the persistent page.

Returns:
value or null for none








setActiveLiveChatId
public VideoLiveStreamingDetails setActiveLiveChatId(String activeLiveChatId)
The ID of the currently active live chat attached to this video. This field is filled only if
 the video is a currently live broadcast that has live chat. Once the broadcast transitions to
 complete this field will be removed and the live chat closed down. For persistent broadcasts
 that live chat id will no longer be tied to this video but rather to the new video being
 displayed at the persistent page.

Parameters:
activeLiveChatId - activeLiveChatId or null for none








getActualEndTime
public com.google.api.client.util.DateTime getActualEndTime()
The time that the broadcast actually ended. This value will not be available until the
 broadcast is over.

Returns:
value or null for none








setActualEndTime
public VideoLiveStreamingDetails setActualEndTime(com.google.api.client.util.DateTime actualEndTime)
The time that the broadcast actually ended. This value will not be available until the
 broadcast is over.

Parameters:
actualEndTime - actualEndTime or null for none








getActualStartTime
public com.google.api.client.util.DateTime getActualStartTime()
The time that the broadcast actually started. This value will not be available until the
 broadcast begins.

Returns:
value or null for none








setActualStartTime
public VideoLiveStreamingDetails setActualStartTime(com.google.api.client.util.DateTime actualStartTime)
The time that the broadcast actually started. This value will not be available until the
 broadcast begins.

Parameters:
actualStartTime - actualStartTime or null for none








getConcurrentViewers
public BigInteger getConcurrentViewers()
The number of viewers currently watching the broadcast. The property and its value will be
 present if the broadcast has current viewers and the broadcast owner has not hidden the
 viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for
 a broadcast when the broadcast ends. So, this property would not identify the number of viewers
 watching an archived video of a live broadcast that already ended.

Returns:
value or null for none








setConcurrentViewers
public VideoLiveStreamingDetails setConcurrentViewers(BigInteger concurrentViewers)
The number of viewers currently watching the broadcast. The property and its value will be
 present if the broadcast has current viewers and the broadcast owner has not hidden the
 viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for
 a broadcast when the broadcast ends. So, this property would not identify the number of viewers
 watching an archived video of a live broadcast that already ended.

Parameters:
concurrentViewers - concurrentViewers or null for none








getScheduledEndTime
public com.google.api.client.util.DateTime getScheduledEndTime()
The time that the broadcast is scheduled to end. If the value is empty or the property is not
 present, then the broadcast is scheduled to contiue indefinitely.

Returns:
value or null for none








setScheduledEndTime
public VideoLiveStreamingDetails setScheduledEndTime(com.google.api.client.util.DateTime scheduledEndTime)
The time that the broadcast is scheduled to end. If the value is empty or the property is not
 present, then the broadcast is scheduled to contiue indefinitely.

Parameters:
scheduledEndTime - scheduledEndTime or null for none








getScheduledStartTime
public com.google.api.client.util.DateTime getScheduledStartTime()
The time that the broadcast is scheduled to begin.

Returns:
value or null for none








setScheduledStartTime
public VideoLiveStreamingDetails setScheduledStartTime(com.google.api.client.util.DateTime scheduledStartTime)
The time that the broadcast is scheduled to begin.

Parameters:
scheduledStartTime - scheduledStartTime or null for none








set
public VideoLiveStreamingDetails set(String fieldName,
                                     Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public VideoLiveStreamingDetails clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














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–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`VideoLiveStreamingDetails`	`clone()`
`String`	`getActiveLiveChatId()` The ID of the currently active live chat attached to this video.
`com.google.api.client.util.DateTime`	`getActualEndTime()` The time that the broadcast actually ended.
`com.google.api.client.util.DateTime`	`getActualStartTime()` The time that the broadcast actually started.
`BigInteger`	`getConcurrentViewers()` The number of viewers currently watching the broadcast.
`com.google.api.client.util.DateTime`	`getScheduledEndTime()` The time that the broadcast is scheduled to end.
`com.google.api.client.util.DateTime`	`getScheduledStartTime()` The time that the broadcast is scheduled to begin.
`VideoLiveStreamingDetails`	`set(String fieldName, Object value)`
`VideoLiveStreamingDetails`	`setActiveLiveChatId(String activeLiveChatId)` The ID of the currently active live chat attached to this video.
`VideoLiveStreamingDetails`	`setActualEndTime(com.google.api.client.util.DateTime actualEndTime)` The time that the broadcast actually ended.
`VideoLiveStreamingDetails`	`setActualStartTime(com.google.api.client.util.DateTime actualStartTime)` The time that the broadcast actually started.
`VideoLiveStreamingDetails`	`setConcurrentViewers(BigInteger concurrentViewers)` The number of viewers currently watching the broadcast.
`VideoLiveStreamingDetails`	`setScheduledEndTime(com.google.api.client.util.DateTime scheduledEndTime)` The time that the broadcast is scheduled to end.
`VideoLiveStreamingDetails`	`setScheduledStartTime(com.google.api.client.util.DateTime scheduledStartTime)` The time that the broadcast is scheduled to begin.