com.baidubce.services.evs

Class EvsClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.evs.EvsClient

public class EvsClient
extends AbstractBceClient

Provides the client for accessing the Baidu Cloud network Service EVS.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FI
static String	FI_COMMAND
static String	GOTO
static String	PRESET
static String	PTZ_COMMAND
static String	SPEED

Fields inherited from class com.baidubce.AbstractBceClient

config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
EvsClient()
EvsClient(BceClientConfiguration clientConfiguration)
EvsClient(BceClientConfiguration config, HttpResponseHandler[] responseHandlers)
EvsClient(BceClientConfiguration config, HttpResponseHandler[] responseHandlers, boolean isHttpAsyncPutEnabled)

Method Summary

Modifier and Type	Method and Description
GbPresetAddResponse	addChannelPreset(long channelId, GbPresetAddRequest request) Used to add presets to the national standard equipment channel.
BindDeviceResponse	bindDeviceBySnCode(BindDeviceRequest request) Used to SnCode for binding bvcp equipment
DeviceCountResponse	countChannelRecoding(long channelId, long begin, long end) Used to query the number of video files of GB28181 device channel
DeviceCountResponse	countChannelThumbnail(long channelId, long begin, long end) Used to query the number of screenshot files of the Gb28181 device channel.
DeviceCountResponse	countDevicehumbnail(long deviceId, long begin, long end) Used to query the number of screenshot files of the RTMP device.
DeviceCountResponse	countDeviceRecoding(long deviceId, long begin, long end) Used to query the number of video files of the RTMP device.
DeviceCreateResponse	createDevice(DeviceCreateRequest request) Use to add EVS device.
SpaceCreateResponse	createSpace(SpaceCreateRequest request) Used to create EVS space
void	deleteChannelPreset(long channelId, int presetId) Used to delete the preset position of the national standard equipment channel.
void	deleteDevice(long deviceId) Used to delete EVS device.
void	deleteSpace(long spaceId) Used to delete EVS space.
void	disableDevice(long deviceId, DeviceStopRequest request) Used to deactivate EVS devices.
void	disableSpace(long spaceId) Used to deactivate the EVS space.
void	enableDevice(long deviceId) Used to enable EVS devices.
void	enableSpace(long spaceId) Used to enable the EVS space.
DeviceChannelSignedUrlResponse	generateChannelSignedUrl(long channelId, String protocol) Used to obtain the channel broadcast signature address according to the domain name
DeviceSignedUrlResponse	generateDeviceSignedUrl(String domain, String app, String stream, String protocol) Used to obtain the device broadcast signature address according to the domain name
DeviceChannelGetResponse	getChannel(long channelId) Used to view the specified GB28181 device channel.
DeviceGetResponse	getDevice(long deviceId) Used to query EVS devices.
GBConfigDownloadResponse	getDeviceGbConfigDownload(long deviceId) Used to query national standard equipment configuration information.
SpaceGetResponse	getSpace(long spaceId) Used to query EVS space configuration information.
void	gotoChannelPreset(long channelId, int presetId) Used to call the preset position of the national standard equipment channel, and quickly move the camera to the preset position.
DeviceChannelListResponse	listChannel(long deviceId) Used to view the channel list of the GB28181 device.
DeviceAiAnalysisListMarkResponse	listChannelAiAnalysisResultByMarker(long channelId, String aiType, DeviceAiAnalysisListMarkRequest request) It is used to query the AI analysis results of GB28181 device channels.
GbPresetListResponse	listChannelPreset(long channelId) Used to query the preset position list of the national standard equipment channel.
DeviceTsStorePageListResponse	listChannelRecord(long channelId, DeviceTsStoreListRequest request) Used to query the video file list of GB28181 device channel.
DeviceTsStorePageListResponse	listChannelThumbnail(long channelId, DeviceTsStoreListRequest request) Used to query the list of screenshot files of GB28181 device channel.
DeviceAiAnalysisListMarkResponse	listDeviceAiAnalysisResultByMarker(long deviceId, String aiType, DeviceAiAnalysisListMarkRequest request) Used to query the AI analysis results of RTMP devices.
DeviceTsStorePageListResponse	listDeviceRecord(long deviceId, DeviceTsStoreListRequest request) Used to query the device's video file list
DeviceTsStorePageListResponse	listDeviceThumbnail(long deviceId, DeviceTsStoreListRequest request) Used to query the device's screenshot file list
DeviceMarkListResponse	listMarkDevice(DeviceListMarkRequest request) Use to query all the devices in user space below the list, by marker query.
SpaceMarkListResponse	listSpaceByMarker(SpaceListMarkRequest request) Query EVS list of all Spaces under the user account in the way of Marker paging.
void	modifyChannelFi(long channelId, String fiCommand, int speed) Used to adjust the aperture and focus of the national standard equipment channel.
void	modifyChannelPtz(long channelId, String ptzCommand, int speed) Used to perform PTZ operation on the national standard equipment channel.
void	modifyDeviceGbPassword(long deviceId, GBDevicePasswordRequest request) Used to modify the user password of the GB28181 device.
void	refreshChannels(long deviceId) Used to refresh the channel of the specified GB28181 device.
void	removeChannelRecord(long channelId, long begin, long end) Used to delete the video files of the GB28181 device channel.
void	removeChannelThumbnail(long channelId, long begin, long end) Used to delete the screenshot file of the GB28181 device channel.
void	removeDeviceRecord(long deviceId, long begin, long end) Used to delete the video files of the RTMP device.
void	removeDeviceThumbnail(long deviceId, long begin, long end) Used to delete the screenshot files of the RTMP device.
void	startChannel(long channelId) Used to enable the specified channel of the GB28181 device.
void	stopChannel(long channelId, DeviceStopRequest request) Used to deactivate the designated channel of the GB28181 device.
void	teleBootDevice(long deviceId) Used to restart the GB28181 device.
DeviceChannelGetResponse	trafficFrameDevice(long channelId, DynamicTrafficFrameRequest dynamicTrafficFrame) Used to set the size of the equipment monitoring frame
void	updateDevice(long deviceId, DeviceUpdateRequest request) Used to modify EVS device configuration.
void	updateSpace(long spaceId, SpaceUpdateRequest request) Used to modify EVS space configuration.

Methods inherited from class com.baidubce.AbstractBceClient

computeBktVirEndpoint, computeServiceId, getBktVirEndpoint, 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

Field Detail

PTZ_COMMAND

public static final String PTZ_COMMAND

See Also:

Constant Field Values

SPEED

public static final String SPEED

See Also:

Constant Field Values

FI

public static final String FI

See Also:

Constant Field Values

FI_COMMAND

public static final String FI_COMMAND

See Also:

Constant Field Values

PRESET

public static final String PRESET

See Also:

Constant Field Values

GOTO

public static final String GOTO

See Also:

Constant Field Values

Constructor Detail

EvsClient

public EvsClient()

EvsClient

public EvsClient(BceClientConfiguration clientConfiguration)

EvsClient

public EvsClient(BceClientConfiguration config,
                 HttpResponseHandler[] responseHandlers)

EvsClient

public EvsClient(BceClientConfiguration config,
                 HttpResponseHandler[] responseHandlers,
                 boolean isHttpAsyncPutEnabled)

Method Detail

createSpace

public SpaceCreateResponse createSpace(SpaceCreateRequest request)

Used to create EVS space

Parameters:

request - Create the required data

Returns:

spaceId 、Upstream and Downstream domain

deleteSpace

public void deleteSpace(long spaceId)

Used to delete EVS space. Delete the specified space according to the space ID. After the space is deleted, all devices in the space will also be deleted.

Parameters:

spaceId - space id

updateSpace

public void updateSpace(long spaceId,
                        SpaceUpdateRequest request)

Used to modify EVS space configuration.

Parameters:

spaceId - space id

request - Update the required data

getSpace

public SpaceGetResponse getSpace(long spaceId)

Used to query EVS space configuration information.

Parameters:

spaceId - space id

Returns:

matching space details

listSpaceByMarker

public SpaceMarkListResponse listSpaceByMarker(SpaceListMarkRequest request)

Query EVS list of all Spaces under the user account in the way of Marker paging.

Parameters:

request - Criteria used to filter at query time

disableSpace

public void disableSpace(long spaceId)

Used to deactivate the EVS space.

Parameters:

spaceId - The space ID to be stopped

enableSpace

public void enableSpace(long spaceId)

Used to enable the EVS space.

Parameters:

spaceId - The space ID to be started

createDevice

public DeviceCreateResponse createDevice(DeviceCreateRequest request)

Use to add EVS device.

Parameters:

request - Create the required data

Returns:

device id

deleteDevice

public void deleteDevice(long deviceId)

Used to delete EVS device.

Parameters:

deviceId - device id

updateDevice

public void updateDevice(long deviceId,
                         DeviceUpdateRequest request)

Used to modify EVS device configuration.

Parameters:

deviceId - device id

request - Modified information

getDevice

public DeviceGetResponse getDevice(long deviceId)

Used to query EVS devices.

Parameters:

deviceId - device id

Returns:

Matching device details

listMarkDevice

public DeviceMarkListResponse listMarkDevice(DeviceListMarkRequest request)

Use to query all the devices in user space below the list, by marker query.

Parameters:

request - Conditions for filtering by paging queries

Returns:

Device list of marker data

disableDevice

public void disableDevice(long deviceId,
                          DeviceStopRequest request)

Used to deactivate EVS devices.

Parameters:

deviceId - The device ID that needs to be deactivated

request - stop time， If request is null, the device is permanently deactivated. If the request body contains a recoverTime parameter, deactivate the device until the recoverTime time is specified.

enableDevice

public void enableDevice(long deviceId)

Used to enable EVS devices.

Parameters:

deviceId - The device ID that needs to be enabled

listDeviceRecord

public DeviceTsStorePageListResponse listDeviceRecord(long deviceId,
                                                      DeviceTsStoreListRequest request)

Used to query the device's video file list

Parameters:

deviceId - device id

request - Query required conditions：Recording start and end time (Unix timestamp) 、pageNo、pageSize

Returns:

Matching video file paging data

countDeviceRecoding

public DeviceCountResponse countDeviceRecoding(long deviceId,
                                               long begin,
                                               long end)

Used to query the number of video files of the RTMP device.

Parameters:

deviceId - device id

begin - Recording start time, Unix timestamp, in seconds.

end - Recording end time, Unix timestamp, in seconds,

Returns:

Recording count

removeDeviceRecord

public void removeDeviceRecord(long deviceId,
                               long begin,
                               long end)

Used to delete the video files of the RTMP device.

Parameters:

deviceId - device id

begin - Recording start time, Unix timestamp, in seconds.

end - Recording end time, Unix timestamp, in seconds,

listDeviceThumbnail

public DeviceTsStorePageListResponse listDeviceThumbnail(long deviceId,
                                                         DeviceTsStoreListRequest request)

Used to query the device's screenshot file list

Parameters:

deviceId - device id

request - Query required conditions：Thumbnail start and end time (Unix timestamp) 、pageNo、pageSize

Returns:

Matching screenshot file paging data

countDevicehumbnail

public DeviceCountResponse countDevicehumbnail(long deviceId,
                                               long begin,
                                               long end)

Used to query the number of screenshot files of the RTMP device.

Parameters:

deviceId - device id

begin - Thumbnail start time, Unix timestamp, in seconds.

end - Thumbnail end time, Unix timestamp, in seconds,

Returns:

Thumbnail count

removeDeviceThumbnail

public void removeDeviceThumbnail(long deviceId,
                                  long begin,
                                  long end)

Used to delete the screenshot files of the RTMP device.

Parameters:

deviceId - device id

begin - Thumbnail start time, Unix timestamp, in seconds.

end - Thumbnail end time, Unix timestamp, in seconds,

listDeviceAiAnalysisResultByMarker

public DeviceAiAnalysisListMarkResponse listDeviceAiAnalysisResultByMarker(long deviceId,
                                                                           String aiType,
                                                                           DeviceAiAnalysisListMarkRequest request)

Used to query the AI analysis results of RTMP devices. It is only used for devices with AI skill configuration enabled in the space configuration.

Parameters:

deviceId - device id

aiType - AI detection type，Support: FACE、BODY、ELECTRIC、CAR_ATTRIBUTE、CAR_MODEL、CAR_PLATE，STATIC_HUMAN_TRAFFIC、STATIC_CAR_TRAFFIC、 QUALITY_BRIGHT、QUALITY_COLOR、QUALITY_COVER、QUALITY_BLUR、QUALITY_NOISE

request - Query required conditions：Recording start and end time (Unix timestamp) 、pageNo、pageSize

Returns:

Matching screenshot file paging data

generateDeviceSignedUrl

public DeviceSignedUrlResponse generateDeviceSignedUrl(String domain,
                                                       String app,
                                                       String stream,
                                                       String protocol)

Used to obtain the device broadcast signature address according to the domain name

Parameters:

domain - domain name

app - device app

stream - device stream

protocol - Agreement name

Returns:

url string

getDeviceGbConfigDownload

public GBConfigDownloadResponse getDeviceGbConfigDownload(long deviceId)

Used to query national standard equipment configuration information.

Parameters:

deviceId - gb device id

Returns:

The configuration details of the designated national standard equipment

teleBootDevice

public void teleBootDevice(long deviceId)

Used to restart the GB28181 device.

Parameters:

deviceId - gb device id

trafficFrameDevice

public DeviceChannelGetResponse trafficFrameDevice(long channelId,
                                                   DynamicTrafficFrameRequest dynamicTrafficFrame)

Used to set the size of the equipment monitoring frame

Parameters:

channelId - channelId ID

dynamicTrafficFrame - equipment monitoring frame config info

Returns:

channelId id

modifyDeviceGbPassword

public void modifyDeviceGbPassword(long deviceId,
                                   GBDevicePasswordRequest request)

Used to modify the user password of the GB28181 device.

Parameters:

deviceId - gb device id

request - new password

listChannel

public DeviceChannelListResponse listChannel(long deviceId)

Used to view the channel list of the GB28181 device.

Parameters:

deviceId - gb device id

Returns:

Channel list details of designated national standard equipment

refreshChannels

public void refreshChannels(long deviceId)

Used to refresh the channel of the specified GB28181 device.

Parameters:

deviceId - gb device id

getChannel

public DeviceChannelGetResponse getChannel(long channelId)

Used to view the specified GB28181 device channel.

Parameters:

channelId - channel id

Returns:

Matching channel details

stopChannel

public void stopChannel(long channelId,
                        DeviceStopRequest request)

Used to deactivate the designated channel of the GB28181 device.

Parameters:

channelId - channel id

request - UTZ time, If it is empty, the device will be disabled permanently, if it is not empty, the device will be disabled until the recoverTime is specified

startChannel

public void startChannel(long channelId)

Used to enable the specified channel of the GB28181 device.

Parameters:

channelId - channel id

generateChannelSignedUrl

public DeviceChannelSignedUrlResponse generateChannelSignedUrl(long channelId,
                                                               String protocol)

Used to obtain the channel broadcast signature address according to the domain name

Parameters:

channelId - channel id

protocol - Agreement name

Returns:

url string

listChannelRecord

public DeviceTsStorePageListResponse listChannelRecord(long channelId,
                                                       DeviceTsStoreListRequest request)

Used to query the video file list of GB28181 device channel.

Parameters:

channelId - channel id

request - Query required conditions：Recording start and end time (Unix timestamp) 、pageNo、pageSize

Returns:

Matching video file paging data

countChannelRecoding

public DeviceCountResponse countChannelRecoding(long channelId,
                                                long begin,
                                                long end)

Used to query the number of video files of GB28181 device channel

Parameters:

channelId - channel id

begin - Recording start time, Unix timestamp, in seconds.

end - Recording end time, Unix timestamp, in seconds,

Returns:

Recording count

removeChannelRecord

public void removeChannelRecord(long channelId,
                                long begin,
                                long end)

Used to delete the video files of the GB28181 device channel.

Parameters:

channelId - channelId id

begin - Recording start time, Unix timestamp, in seconds.

end - Recording end time, Unix timestamp, in seconds,

listChannelThumbnail

public DeviceTsStorePageListResponse listChannelThumbnail(long channelId,
                                                          DeviceTsStoreListRequest request)

Used to query the list of screenshot files of GB28181 device channel.

Parameters:

channelId - channelId id

request - Query required conditions：Thumbnail start and end time (Unix timestamp) 、pageNo、pageSize

Returns:

Matching screenshot file paging data

countChannelThumbnail

public DeviceCountResponse countChannelThumbnail(long channelId,
                                                 long begin,
                                                 long end)

Used to query the number of screenshot files of the Gb28181 device channel.

Parameters:

channelId - channel id

begin - Thumbnail start time, Unix timestamp, in seconds.

end - Thumbnail end time, Unix timestamp, in seconds,

Returns:

Thumbnail count

removeChannelThumbnail

public void removeChannelThumbnail(long channelId,
                                   long begin,
                                   long end)

Used to delete the screenshot file of the GB28181 device channel.

Parameters:

channelId - channel id

begin - Thumbnail start time, Unix timestamp, in seconds.

end - Thumbnail end time, Unix timestamp, in seconds,

listChannelAiAnalysisResultByMarker

public DeviceAiAnalysisListMarkResponse listChannelAiAnalysisResultByMarker(long channelId,
                                                                            String aiType,
                                                                            DeviceAiAnalysisListMarkRequest request)

It is used to query the AI analysis results of GB28181 device channels. It is only used for the device channels with AI skill configuration enabled in the space configuration.

Parameters:

channelId - channel id

aiType - AI detection type，Support: FACE、BODY、ELECTRIC、CAR_ATTRIBUTE、CAR_MODEL、CAR_PLATE，STATIC_HUMAN_TRAFFIC、STATIC_CAR_TRAFFIC、 QUALITY_BRIGHT、QUALITY_COLOR、QUALITY_COVER、QUALITY_BLUR、QUALITY_NOISE

request - Query required conditions：Recording start and end time (Unix timestamp) 、pageNo、pageSize

Returns:

Matching screenshot file paging data

modifyChannelPtz

public void modifyChannelPtz(long channelId,
                             String ptzCommand,
                             int speed)

Used to perform PTZ operation on the national standard equipment channel.

Parameters:

channelId - channel id

ptzCommand - ptz command, support： stop/left/right/up/down/zoomin/zoomout/left_up/left_down/right_up/right_down

speed - Adjust the speed, support 1-255 for up, down, left and right operation, and 1-15 for zoom operation

modifyChannelFi

public void modifyChannelFi(long channelId,
                            String fiCommand,
                            int speed)

Used to adjust the aperture and focus of the national standard equipment channel.

Parameters:

channelId - channel id

fiCommand - support：stop/irisin/irisout/focusnear/focusfar

speed - Adjust the speed, support 1-255

addChannelPreset

public GbPresetAddResponse addChannelPreset(long channelId,
                                            GbPresetAddRequest request)

Used to add presets to the national standard equipment channel.

Parameters:

channelId - channel id

request - Preset position name, the maximum length is 100

Returns:

Preset Id

Note: Before initiating the request to add a preset position, make sure that the camera has been adjusted to the expected position and angle through the ptz control.

deleteChannelPreset

public void deleteChannelPreset(long channelId,
                                int presetId)

Used to delete the preset position of the national standard equipment channel.

Parameters:

channelId - channel id

presetId - preset Id

listChannelPreset

public GbPresetListResponse listChannelPreset(long channelId)

Used to query the preset position list of the national standard equipment channel.

Parameters:

channelId - channel id

Returns:

Specify the list of all preset positions of GBT

gotoChannelPreset

public void gotoChannelPreset(long channelId,
                              int presetId)

Used to call the preset position of the national standard equipment channel, and quickly move the camera to the preset position.

Parameters:

channelId - channel id

presetId - preset Id

bindDeviceBySnCode

public BindDeviceResponse bindDeviceBySnCode(BindDeviceRequest request)

Used to SnCode for binding bvcp equipment

Parameters:

request - Bind the required data

Returns:

deviceId and snCode