com.baidubce.services.lss

Class LssClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.lss.LssClient

public class LssClient
extends AbstractBceClient

Client for accessing Live Streaming Service. All service calls made using this client are blocking, and will not return until the service call completes.

Field Summary

Fields inherited from class com.baidubce.AbstractBceClient

config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
LssClient() Constructs a new Lss client.
LssClient(BceClientConfiguration clientConfiguration) Constructs a new client using the client configuration.

Method Summary

Methods

Modifier and Type	Method and Description
CreatePresetResponse	createForwardOnlyPreset(String presetName, String description, Hls hls, Rtmp rtmp, Recording recording, LiveThumbnail thumbnail) Create a live preset which contains parameters needed in the live stream service, and in forward only mode, in which the input stream's resolution ratio and code rate will be kept unchanged.
CreateNotificationResponse	createNotification(CreateNotificationRequest request) Create a live notification in the live stream service.
CreateNotificationResponse	createNotification(String name, String endpoint) Create a live notification in the live stream service.
CreatePresetResponse	createPreset(CreatePresetRequest request) Create a live preset which contains parameters needed in the live stream service.
CreatePresetResponse	createPreset(String presetName, String description, Audio audio, Video video, Hls hls, Rtmp rtmp, Recording recording) Create a live preset which contains parameters needed in the live stream service.
CreatePresetResponse	createPreset(String presetName, String description, Audio audio, Video video, Hls hls, Rtmp rtmp, Recording recording, LiveThumbnail thumbnail) Create a live preset which contains parameters needed in the live stream service, and not in forward only mode, so that the input stream will be transcoded according to audio and video parameters.
CreateSessionResponse	createSession(CreateSessionRequest request) Create a live session in the live stream service.
CreateSessionResponse	createSession(String presetName, String description, String notification, LivePublishInfo publish, LiveTarget target) Create a live session in the live stream service.
DeleteNotificationResponse	deleteNotification(DeleteNotificationRequest request) Delete your live notification by live notification name.
DeleteNotificationResponse	deleteNotification(String name) Delete your live notification by live notification name.
DeletePresetResponse	deletePreset(DeletePresetRequest request) Delete your live presets by live preset name.
DeletePresetResponse	deletePreset(String presetName) Delete your live presets by live preset name.
DeleteSessionResponse	deleteSession(DeleteSessionRequest request) Delete your live session by live session id.
DeleteSessionResponse	deleteSession(String sessionId) Delete your live session by live session id.
GetNotificationResponse	getNotification(GetNotificationRequest request) Get your live notification by live notification name.
GetNotificationResponse	getNotification(String name) Get your live notification by live notification name.
GetPresetResponse	getPreset(GetPresetRequest request) Get your live preset by live preset name.
GetPresetResponse	getPreset(String presetName) Get your live preset by live preset name.
GetSessionResponse	getSession(GetSessionRequest request) Get your live session by live session id.
GetSessionResponse	getSession(String sessionId) Get your live session by live session id.
ListNotificationsResponse	listNotifications() List all your live notifications.
ListPresetsResponse	listPresets() List all your live presets.
ListSessionsResponse	listSessions() List all your live sessions.
ListSessionsResponse	listSessions(ListSessionsRequest request) List all your live sessions.
ListSessionsResponse	listSessions(String status) List all your live sessions with given status.
PauseSessionResponse	pauseSession(PauseSessionRequest request) Pause your live session by live session id.
PauseSessionResponse	pauseSession(String sessionId) Pause your live session by live session id.
RefreshSessionResponse	refreshSession(RefreshSessionRequest request) Refresh your live session by live session id.
RefreshSessionResponse	refreshSession(String sessionId) Refresh your live session by live session id.
ResumeSessionResponse	resumeSession(ResumeSessionRequest request) Resume your live session by live session id.
ResumeSessionResponse	resumeSession(String sessionId) Resume your live session by live session id.

Methods inherited from class com.baidubce.AbstractBceClient

getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

LssClient

public LssClient()

Constructs a new Lss client.

LssClient

public LssClient(BceClientConfiguration clientConfiguration)

Constructs a new client using the client configuration.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Lss services (e.g. proxy settings, retry counts, etc).

Method Detail

createPreset

public CreatePresetResponse createPreset(String presetName,
                                String description,
                                Audio audio,
                                Video video,
                                Hls hls,
                                Rtmp rtmp,
                                Recording recording)

Create a live preset which contains parameters needed in the live stream service.

Parameters:

presetName - The name of the new live preset.

description - The description of the new live preset

audio - Specify the audio format of live stream.

video - Specify the video format of live stream.

hls - Specify the hls format of live stream.

rtmp - Specify the rtmp format of live stream.

recording - Specify the recording format of live stream.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                String description,
                                Audio audio,
                                Video video,
                                Hls hls,
                                Rtmp rtmp,
                                Recording recording,
                                LiveThumbnail thumbnail)

Create a live preset which contains parameters needed in the live stream service, and not in forward only mode, so that the input stream will be transcoded according to audio and video parameters.

Parameters:

presetName - The name of the new live preset.

description - The description of the new live preset

audio - Specify the audio format of live stream.

video - Specify the video format of live stream.

hls - Specify the hls format of live stream.

rtmp - Specify the rtmp format of live stream.

recording - Specify the recording format of live stream.

thumbnail - Specify the thumbnail format of live stream.

createForwardOnlyPreset

public CreatePresetResponse createForwardOnlyPreset(String presetName,
                                           String description,
                                           Hls hls,
                                           Rtmp rtmp,
                                           Recording recording,
                                           LiveThumbnail thumbnail)

Create a live preset which contains parameters needed in the live stream service, and in forward only mode, in which the input stream's resolution ratio and code rate will be kept unchanged.

Parameters:

presetName - The name of the new live preset.

hls - Specify the hls format of live stream.

rtmp - Specify the rtmp format of live stream.

recording - Specify the recording format of live stream.

thumbnail - Specify the thumbnail format of live stream.

createPreset

public CreatePresetResponse createPreset(CreatePresetRequest request)

Create a live preset which contains parameters needed in the live stream service.

Parameters:

request - The request object containing all options for creating presets.

listPresets

public ListPresetsResponse listPresets()

List all your live presets.

Returns:

The list of all your live presets

getPreset

public GetPresetResponse getPreset(String presetName)

Get your live preset by live preset name.

Parameters:

presetName - Live preset name.

Returns:

Your live preset

getPreset

public GetPresetResponse getPreset(GetPresetRequest request)

Get your live preset by live preset name.

Parameters:

request - The request object containing all parameters for getting live preset.

Returns:

Your live preset

deletePreset

public DeletePresetResponse deletePreset(String presetName)

Delete your live presets by live preset name.

Parameters:

presetName - Live preset name.

deletePreset

public DeletePresetResponse deletePreset(DeletePresetRequest request)

Delete your live presets by live preset name.

Parameters:

request - The request object containing all parameters for deleting live preset.

createSession

public CreateSessionResponse createSession(String presetName,
                                  String description,
                                  String notification,
                                  LivePublishInfo publish,
                                  LiveTarget target)

Create a live session in the live stream service.

Parameters:

presetName - The name of the new live session.

description - The description of the new live session.

notification - The notification of the new live session.

publish - Specify the LivePublishInfo of live session.

target - Specify the LiveTarget of live session.

createSession

public CreateSessionResponse createSession(CreateSessionRequest request)

Create a live session in the live stream service.

Parameters:

request - The request object containing all options for creating live session.

listSessions

public ListSessionsResponse listSessions()

List all your live sessions.

Returns:

The list of all your live sessions.

listSessions

public ListSessionsResponse listSessions(String status)

List all your live sessions with given status.

Parameters:

status - Live session status.

Returns:

The list of all your live sessions.

listSessions

public ListSessionsResponse listSessions(ListSessionsRequest request)

List all your live sessions.

Parameters:

request - The request object containing all parameters for listing live sessions.

Returns:

The list of all your live sessions.

getSession

public GetSessionResponse getSession(String sessionId)

Get your live session by live session id.

Parameters:

sessionId - Live session id.

Returns:

Your live session.

getSession

public GetSessionResponse getSession(GetSessionRequest request)

Get your live session by live session id.

Parameters:

request - The request object containing all parameters for getting live session.

Returns:

Your live session.

deleteSession

public DeleteSessionResponse deleteSession(String sessionId)

Delete your live session by live session id.

Parameters:

sessionId - Live session id.

deleteSession

public DeleteSessionResponse deleteSession(DeleteSessionRequest request)

Delete your live session by live session id.

Parameters:

request - The request object containing all parameters for deleting live session.

pauseSession

public PauseSessionResponse pauseSession(String sessionId)

Pause your live session by live session id.

Parameters:

sessionId - Live session id.

pauseSession

public PauseSessionResponse pauseSession(PauseSessionRequest request)

Pause your live session by live session id.

Parameters:

request - The request object containing all parameters for pausing live session.

resumeSession

public ResumeSessionResponse resumeSession(String sessionId)

Resume your live session by live session id.

Parameters:

sessionId - Live session id.

resumeSession

public ResumeSessionResponse resumeSession(ResumeSessionRequest request)

Resume your live session by live session id.

Parameters:

request - The request object containing all parameters for resuming live session.

refreshSession

public RefreshSessionResponse refreshSession(String sessionId)

Refresh your live session by live session id.

Parameters:

sessionId - Live session id.

refreshSession

public RefreshSessionResponse refreshSession(RefreshSessionRequest request)

Refresh your live session by live session id.

Parameters:

request - The request object containing all parameters for refreshing live session.

listNotifications

public ListNotificationsResponse listNotifications()

List all your live notifications.

Returns:

The list of all your live notifications

deleteNotification

public DeleteNotificationResponse deleteNotification(String name)

Delete your live notification by live notification name.

Parameters:

name - Live notification name.

deleteNotification

public DeleteNotificationResponse deleteNotification(DeleteNotificationRequest request)

Delete your live notification by live notification name.

Parameters:

request - The request object containing all parameters for deleting live notification.

getNotification

public GetNotificationResponse getNotification(String name)

Get your live notification by live notification name.

Parameters:

name - Live notification name.

Returns:

Your live notification.

getNotification

public GetNotificationResponse getNotification(GetNotificationRequest request)

Get your live notification by live notification name.

Parameters:

request - The request object containing all parameters for getting live notification.

Returns:

Your live notification.

createNotification

public CreateNotificationResponse createNotification(String name,
                                            String endpoint)

Create a live notification in the live stream service.

Parameters:

name - The name of notification.

endpoint - The address to receive notification message.

createNotification

public CreateNotificationResponse createNotification(CreateNotificationRequest request)

Create a live notification in the live stream service.

Parameters:

request - The request object containing all options for creating live notification.