Class LivestreamServiceClient (0.1.4)

LivestreamServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.video.live_stream_v1.services.livestream_service.transports.base.LivestreamServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).

Inheritance

builtins.object > LivestreamServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
LivestreamServiceTransport	The transport used by the client instance.

Methods

LivestreamServiceClient

LivestreamServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.video.live_stream_v1.services.livestream_service.transports.base.LivestreamServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the livestream service client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	`Union[str, LivestreamServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

channel_path

channel_path(project: str, location: str, channel: str)

Returns a fully-qualified channel string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_channel

create_channel(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.CreateChannelRequest, dict]] = None, *, parent: Optional[str] = None, channel: Optional[google.cloud.video.live_stream_v1.types.resources.Channel] = None, channel_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a channel with the provided unique ID in the specified region.

from google.cloud.video import live_stream_v1

def sample_create_channel():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.CreateChannelRequest(
        parent="parent_value",
        channel_id="channel_id_value",
    )

    # Make the request
    operation = client.create_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.CreateChannelRequest, dict]` The request object. Request message for "LivestreamService.CreateChannel".
parent	`str` Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
channel	`google.cloud.video.live_stream_v1.types.Channel` Required. The channel resource to be created. This corresponds to the `channel` field on the `request` instance; if `request` is provided, this should not be set.
channel_id	`str` Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with `[a-z0-9]`, could contain dashes (-) in between. This corresponds to the `channel_id` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Channel Channel resource represents the processor that does a user-defined "streaming" operation, which includes getting an input stream through an input, transcoding it to multiple renditions, and publishing output live streams in certain formats (for example, HLS or DASH) to the specified location.

create_event

create_event(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.CreateEventRequest, dict]] = None, *, parent: Optional[str] = None, event: Optional[google.cloud.video.live_stream_v1.types.resources.Event] = None, event_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an event with the provided unique ID in the specified channel.

from google.cloud.video import live_stream_v1

def sample_create_event():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.CreateEventRequest(
        parent="parent_value",
        event_id="event_id_value",
    )

    # Make the request
    response = client.create_event(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.CreateEventRequest, dict]` The request object. Request message for "LivestreamService.CreateEvent".
parent	`str` Required. The parent channel for the resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
event	`google.cloud.video.live_stream_v1.types.Event` Required. The event resource to be created. This corresponds to the `event` field on the `request` instance; if `request` is provided, this should not be set.
event_id	`str` Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with `[a-z0-9]`, could contain dashes (-) in between. This corresponds to the `event_id` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.types.Event	Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.

create_input

create_input(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.CreateInputRequest, dict]] = None, *, parent: Optional[str] = None, input: Optional[google.cloud.video.live_stream_v1.types.resources.Input] = None, input_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an input with the provided unique ID in the specified region.

from google.cloud.video import live_stream_v1

def sample_create_input():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.CreateInputRequest(
        parent="parent_value",
        input_id="input_id_value",
    )

    # Make the request
    operation = client.create_input(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.CreateInputRequest, dict]` The request object. Request message for "LivestreamService.CreateInput".
parent	`str` Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
input	`google.cloud.video.live_stream_v1.types.Input` Required. The input resource to be created. This corresponds to the `input` field on the `request` instance; if `request` is provided, this should not be set.
input_id	`str` Required. The ID of the input resource to be created. This value must be 1-63 characters, begin and end with `[a-z0-9]`, could contain dashes (-) in between. This corresponds to the `input_id` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Input Input resource represents the endpoint from which the channel ingests the input stream.

delete_channel

delete_channel(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.DeleteChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified channel.

from google.cloud.video import live_stream_v1

def sample_delete_channel():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.DeleteChannelRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.DeleteChannelRequest, dict]` The request object. Request message for "LivestreamService.DeleteChannel".
name	`str` Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type

Description

google.api_core.operation.Operation

An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

delete_event

delete_event(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.DeleteEventRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified event.

from google.cloud.video import live_stream_v1

def sample_delete_event():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.DeleteEventRequest(
        name="name_value",
    )

    # Make the request
    client.delete_event(request=request)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.DeleteEventRequest, dict]` The request object. Request message for "LivestreamService.DeleteEvent".
name	`str` Required. The name of the event resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_input

delete_input(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.DeleteInputRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified input.

from google.cloud.video import live_stream_v1

def sample_delete_input():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.DeleteInputRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_input(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.DeleteInputRequest, dict]` The request object. Request message for "LivestreamService.DeleteInput".
name	`str` Required. The name of the input resource, in the form of: `projects/{project}/locations/{location}/inputs/{inputId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type

Description

google.api_core.operation.Operation

event_path

event_path(project: str, location: str, channel: str, event: str)

Returns a fully-qualified event string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
LivestreamServiceClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
LivestreamServiceClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
LivestreamServiceClient	The constructed client.

get_channel

get_channel(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.GetChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified channel.

from google.cloud.video import live_stream_v1

def sample_get_channel():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.GetChannelRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_channel(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.GetChannelRequest, dict]` The request object. Request message for "LivestreamService.GetChannel".
name	`str` Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.types.Channel	Channel resource represents the processor that does a user-defined "streaming" operation, which includes getting an input stream through an input, transcoding it to multiple renditions, and publishing output live streams in certain formats (for example, HLS or DASH) to the specified location.

get_event

get_event(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.GetEventRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified event.

from google.cloud.video import live_stream_v1

def sample_get_event():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.GetEventRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_event(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.GetEventRequest, dict]` The request object. Request message for "LivestreamService.GetEvent".
name	`str` Required. The name of the event resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.types.Event	Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.

get_input

get_input(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.GetInputRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified input.

from google.cloud.video import live_stream_v1

def sample_get_input():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.GetInputRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_input(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.GetInputRequest, dict]` The request object. Request message for "LivestreamService.GetInput".
name	`str` Required. The name of the input resource, in the form of: `projects/{project}/locations/{location}/inputs/{inputId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.types.Input	Input resource represents the endpoint from which the channel ingests the input stream.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

input_path

input_path(project: str, location: str, input: str)

Returns a fully-qualified input string.

list_channels

list_channels(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.ListChannelsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a list of all channels in the specified region.

from google.cloud.video import live_stream_v1

def sample_list_channels():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.ListChannelsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channels(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.ListChannelsRequest, dict]` The request object. Request message for "LivestreamService.ListChannels".
parent	`str` Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.services.livestream_service.pagers.ListChannelsPager	Response message for "LivestreamService.ListChannels". Iterating over this object will yield results and resolve additional pages automatically.

list_events

list_events(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.ListEventsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a list of all events in the specified channel.

from google.cloud.video import live_stream_v1

def sample_list_events():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.ListEventsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_events(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.ListEventsRequest, dict]` The request object. Request message for "LivestreamService.ListEvents".
parent	`str` Required. The parent channel for the resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.services.livestream_service.pagers.ListEventsPager	Response message for "LivestreamService.ListEvents". Iterating over this object will yield results and resolve additional pages automatically.

list_inputs

list_inputs(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.ListInputsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a list of all inputs in the specified region.

from google.cloud.video import live_stream_v1

def sample_list_inputs():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.ListInputsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_inputs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.ListInputsRequest, dict]` The request object. Request message for "LivestreamService.ListInputs".
parent	`str` Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.video.live_stream_v1.services.livestream_service.pagers.ListInputsPager	Response message for "LivestreamService.ListInputs". Iterating over this object will yield results and resolve additional pages automatically.

parse_channel_path

parse_channel_path(path: str)

Parses a channel path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_event_path

parse_event_path(path: str)

Parses a event path into its component segments.

parse_input_path

parse_input_path(path: str)

Parses a input path into its component segments.

start_channel

start_channel(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.StartChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts the specified channel. Part of the video pipeline will be created only when the StartChannel request is received by the server.

from google.cloud.video import live_stream_v1

def sample_start_channel():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.StartChannelRequest(
        name="name_value",
    )

    # Make the request
    operation = client.start_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.StartChannelRequest, dict]` The request object. Request message for "LivestreamService.StartChannel".
name	`str` Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ChannelOperationResponse Response message for Start/Stop Channel long-running operations.

stop_channel

stop_channel(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.StopChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops the specified channel. Part of the video pipeline will be released when the StopChannel request is received by the server.

from google.cloud.video import live_stream_v1

def sample_stop_channel():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.StopChannelRequest(
        name="name_value",
    )

    # Make the request
    operation = client.stop_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.StopChannelRequest, dict]` The request object. Request message for "LivestreamService.StopChannel".
name	`str` Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ChannelOperationResponse Response message for Start/Stop Channel long-running operations.

update_channel

update_channel(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.UpdateChannelRequest, dict]] = None, *, channel: Optional[google.cloud.video.live_stream_v1.types.resources.Channel] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified channel.

from google.cloud.video import live_stream_v1

def sample_update_channel():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.UpdateChannelRequest(
    )

    # Make the request
    operation = client.update_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.UpdateChannelRequest, dict]` The request object. Request message for "LivestreamService.UpdateChannel".
channel	`google.cloud.video.live_stream_v1.types.Channel` Required. The channel resource to be updated. This corresponds to the `channel` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields: - inputAttachments`` <https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#inputattachment>`__ -output<https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#output>`__ - ```elementaryStreams https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#ElementaryStream__ - ```muxStreams`` <https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#muxstream> - `manifests https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#Manifest` - `spritesheets https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#spritesheet`__ The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Channel Channel resource represents the processor that does a user-defined "streaming" operation, which includes getting an input stream through an input, transcoding it to multiple renditions, and publishing output live streams in certain formats (for example, HLS or DASH) to the specified location.

update_input

update_input(request: Optional[Union[google.cloud.video.live_stream_v1.types.service.UpdateInputRequest, dict]] = None, *, input: Optional[google.cloud.video.live_stream_v1.types.resources.Input] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified input.

from google.cloud.video import live_stream_v1

def sample_update_input():
    # Create a client
    client = live_stream_v1.LivestreamServiceClient()

    # Initialize request argument(s)
    request = live_stream_v1.UpdateInputRequest(
    )

    # Make the request
    operation = client.update_input(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.video.live_stream_v1.types.UpdateInputRequest, dict]` The request object. Request message for "LivestreamService.UpdateInput".
input	`google.cloud.video.live_stream_v1.types.Input` Required. The input resource to be updated. This corresponds to the `input` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields to be overwritten in the Input resource by the update. You can only update the following fields: - preprocessingConfig`` <https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#PreprocessingConfig>`__ -securityRules<https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#SecurityRule>`__ The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. This corresponds to theupdate_mask`field on the`request`instance; if`request`` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Input Input resource represents the endpoint from which the channel ingests the input stream.