VcrClient (bce-sdk-java 0.10.328 API)

java.lang.Object
- com.baidubce.AbstractBceClient
- - com.baidubce.services.vcr.VcrClient

```
public class VcrClient
extends AbstractBceClient
```
Provides the client for accessing the BCE Video Content Regulation service.

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

VcrClient()

VcrClient(BceClientConfiguration config)

Constructors
Constructor and Description
`VcrClient()`
`VcrClient(BceClientConfiguration config)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LibResponse`	`addFaceImage(LibImageRequest request)` add face lib image
`LibResponse`	`addFaceImage(String lib, String brief, String image)` add face lib image
`LibResponse`	`addLogoImage(LibImageRequest request)` add logo lib image
`LibResponse`	`addLogoImage(String lib, String brief, String image)` add logo lib image
`CancelStreamResponse`	`cancelStreamV2(CancelStreamRequest request)` Cancel an stream check task with the request.
`LibResponse`	`delFaceBrief(LibBriefRequest request)` delete face lib brief
`LibResponse`	`delFaceBrief(String lib, String brief)` delete face lib brief
`LibResponse`	`delFaceImage(LibImageRequest request)` delete face lib image
`LibResponse`	`delFaceImage(String lib, String brief, String image)` delete face lib image
`LibResponse`	`delLogoBrief(LibBriefRequest request)` delete logo brief
`LibResponse`	`delLogoBrief(String lib, String brief)` delete logo lib brief
`LibResponse`	`delLogoImage(LibImageRequest request)` delete logo lib image
`LibResponse`	`delLogoImage(String lib, String image)` delete logo lib image
`GetAudioResponse`	`getAudio(GetAudioRequest request)`
`GetAudioResponse`	`getAudio(String source)` Get an audio check task result with the specified source.
`LibImageResponse`	`getFaceBrief(LibBriefRequest request)` get face lib image
`LibImageResponse`	`getFaceBrief(String lib, String brief)` get face lib image
`LibBriefResponse`	`getFaceLib(LibBriefRequest request)` get face lib brief list
`LibBriefResponse`	`getFaceLib(String lib)` get face lib brief list
`GetImageAsyncResponse`	`getImageAsync(GetImageAsyncRequest request)`
`GetImageAsyncResponse`	`getImageAsync(String source, String preset)` Get a image async check task result temporary with the specified source and preset.
`LibImageResponse`	`getLogoBrief(LibBriefRequest request)` get logo lib image list
`LibImageResponse`	`getLogoBrief(String lib, String brief)` get logo lib image list
`LibBriefResponse`	`getLogoLib(LibBriefRequest request)` get logo lib brief list
`LibBriefResponse`	`getLogoLib(String lib)` get logo lib brief list
`GetMediaResponse`	`getMedia(GetMediaRequest request)`
`GetMediaResponse`	`getMedia(String source)` Get a media check task result with the specified source.
`GetMediaCharacterResponse`	`getMediaCharacter(GetMediaRequest request)`
`GetMediaCharacterResponse`	`getMediaCharacter(String source)`
`GetMediaSpeechResponse`	`getMediaSpeech(GetMediaRequest request)`
`GetMediaSpeechResponse`	`getMediaSpeech(String source)`
`GetStreamResponse`	`getStream(GetStreamRequest request)` Deprecated.
`GetStreamResponse`	`getStream(String source)` Deprecated.
`GetStreamCheckTaskListResponse`	`getStreamCheckTaskListV2(GetStreamCheckTaskListRequest request)` Get a stream check task list with the specified maxKeys, marker and status.
`GetStreamCheckTaskListResponse`	`getStreamCheckTaskListV2(Integer maxKeys, String marker, String status)` Get a stream check task list with the specified maxKeys, marker and status.
`GetStreamResponse`	`getStreamV2(GetStreamRequest request)` Get a stream check task result with GetStreamRequest.
`GetStreamResponse`	`getStreamV2(String source)` Get a stream check task result with the specified source.
`PutAudioResponse`	`putAudio(PutAudioRequest request)`
`PutAudioResponse`	`putAudio(String source)` Create an audio check task with the specified source.
`PutImageResponse`	`putImage(PutImageRequest request)`
`PutImageResponse`	`putImage(String source)` Create a image check task with the specified source.
`PutImageResponse`	`putImage(String source, String preset)`
`PutImageAsyncResponse`	`putImageAsync(PutImageAsyncRequest request)`
`PutImageAsyncResponse`	`putImageAsync(String source, String preset, String notification)` Create a image async check task, the result will callback through notification service.
`PutMediaResponse`	`putMedia(PutMediaRequest request)`
`PutMediaResponse`	`putMedia(String source)` Create a media check task with the specified source.
`PutStreamResponse`	`putStream(PutStreamRequest request)` Deprecated.
`PutStreamResponse`	`putStream(String source)` Deprecated.
`PutStreamResponse`	`putStreamV2(PutStreamRequest request)` Create an stream check task with the request.
`PutTextResponse`	`putText(PutTextRequest request)`
`PutTextResponse`	`putText(String text)` Create a text check task with content.

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

- Constructor Detail
  - VcrClient
```
public VcrClient()
```
  - VcrClient
```
public VcrClient(BceClientConfiguration config)
```
- Method Detail
  - putMedia
```
public PutMediaResponse putMedia(String source)
```
    Create a media check task with the specified source.
    
    Parameters:
    
    source - The source of media
    
    Returns:
    
    PutMediaResponse
  - putMedia
```
public PutMediaResponse putMedia(PutMediaRequest request)
```
  - getMedia
```
public GetMediaResponse getMedia(String source)
```
    Get a media check task result with the specified source.
    
    Parameters:
    
    source - The source of media
    
    Returns:
    
    result of the media check task
  - getMedia
```
public GetMediaResponse getMedia(GetMediaRequest request)
```
  - getMediaSpeech
```
public GetMediaSpeechResponse getMediaSpeech(String source)
```
  - getMediaSpeech
```
public GetMediaSpeechResponse getMediaSpeech(GetMediaRequest request)
```
  - getMediaCharacter
```
public GetMediaCharacterResponse getMediaCharacter(String source)
```
  - getMediaCharacter
```
public GetMediaCharacterResponse getMediaCharacter(GetMediaRequest request)
```
  - putStream
```
@Deprecated
public PutStreamResponse putStream(String source)
```
    Deprecated.
    
    This interface is no longer supported, please use new interface putStreamV2.
  - putStream
```
@Deprecated
public PutStreamResponse putStream(PutStreamRequest request)
```
    Deprecated.
    
    This interface is no longer supported, please use new interface putStreamV2.
  - putStreamV2
```
public PutStreamResponse putStreamV2(PutStreamRequest request)
```
    Create an stream check task with the request.
    
    Parameters:
    
    request: - The request when check stream
    
    Returns:
    
    PutStreamResponse
  - cancelStreamV2
```
public CancelStreamResponse cancelStreamV2(CancelStreamRequest request)
```
    Cancel an stream check task with the request.
    
    Parameters:
    
    request: - The request when cancel stream
    
    Returns:
    
    CancelStreamResponse
  - getStream
```
@Deprecated
public GetStreamResponse getStream(String source)
```
    Deprecated.
    
    This interface is no longer supported, please use new interface getStreamV2.
  - getStream
```
@Deprecated
public GetStreamResponse getStream(GetStreamRequest request)
```
    Deprecated.
    
    This interface is no longer supported, please use new interface getStreamV2.
  - getStreamV2
```
public GetStreamResponse getStreamV2(String source)
```
    Get a stream check task result with the specified source.
    
    Parameters:
    
    source: - The source of stream
    
    Returns:
    
    GetStreamResponse
  - getStreamV2
```
public GetStreamResponse getStreamV2(GetStreamRequest request)
```
    Get a stream check task result with GetStreamRequest.
    
    Parameters:
    
    request: - The request when get stream response
    
    Returns:
    
    GetStreamResponse
  - getStreamCheckTaskListV2
```
public GetStreamCheckTaskListResponse getStreamCheckTaskListV2(Integer maxKeys,
                                                               String marker,
                                                               String status)
```
    Get a stream check task list with the specified maxKeys, marker and status.
    
    Parameters:
    
    maxKeys: - The stream check task number when return, max value is 100
    
    marker: - Starting position of this query, first query not use this value
    
    status: - The stream check status of stream
    
    Returns:
    
    GetStreamCheckTaskListResponse
  - getStreamCheckTaskListV2
```
public GetStreamCheckTaskListResponse getStreamCheckTaskListV2(GetStreamCheckTaskListRequest request)
```
    Get a stream check task list with the specified maxKeys, marker and status.
    
    Parameters:
    
    request: - The request when get stream check task list
    
    Returns:
    
    GetStreamCheckTaskListResponse
  - putAudio
```
public PutAudioResponse putAudio(String source)
```
    Create an audio check task with the specified source.
    
    Parameters:
    
    source - The source of audio
    
    Returns:
    
    PutAudioResponse
  - putAudio
```
public PutAudioResponse putAudio(PutAudioRequest request)
```
  - getAudio
```
public GetAudioResponse getAudio(String source)
```
    Get an audio check task result with the specified source.
    
    Parameters:
    
    source - The source of audio
    
    Returns:
    
    result of the audio check task
  - getAudio
```
public GetAudioResponse getAudio(GetAudioRequest request)
```
  - putImage
```
public PutImageResponse putImage(String source)
```
    Create a image check task with the specified source.
    
    Parameters:
    
    source - The source of image
    
    Returns:
    
    result of the image check task
  - putImage
```
public PutImageResponse putImage(String source,
                                 String preset)
```
  - putImage
```
public PutImageResponse putImage(PutImageRequest request)
```
  - putImageAsync
```
public PutImageAsyncResponse putImageAsync(String source,
                                           String preset,
                                           String notification)
```
    Create a image async check task, the result will callback through notification service.
    
    Parameters:
    
    source - The source of image
    
    preset - The preset of check, can be null
    
    notification - The name of notification, can be null
    
    Returns:
    
    PutImageAsyncResponse
  - putImageAsync
```
public PutImageAsyncResponse putImageAsync(PutImageAsyncRequest request)
```
  - getImageAsync
```
public GetImageAsyncResponse getImageAsync(String source,
                                           String preset)
```
    Get a image async check task result temporary with the specified source and preset.
    
    Parameters:
    
    source - The source of image
    
    preset - The preset of check, should be same with the preset in putImageAsync
    
    Returns:
    
    result of the image async check task
  - getImageAsync
```
public GetImageAsyncResponse getImageAsync(GetImageAsyncRequest request)
```
  - putText
```
public PutTextResponse putText(String text)
```
    Create a text check task with content.
    
    Parameters:
    
    text - The content of text
    
    Returns:
    
    result of the text check task
  - putText
```
public PutTextResponse putText(PutTextRequest request)
```
  - addFaceImage
```
public LibResponse addFaceImage(String lib,
                                String brief,
                                String image)
```
    add face lib image
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    image - image url.
    
    Returns:
    
    the final response object
  - addFaceImage
```
public LibResponse addFaceImage(LibImageRequest request)
```
    add face lib image
    
    Parameters:
    
    request - image request object.
    
    Returns:
    
    the final response object
  - delFaceBrief
```
public LibResponse delFaceBrief(String lib,
                                String brief)
```
    delete face lib brief
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    Returns:
    
    the final response object
  - delFaceBrief
```
public LibResponse delFaceBrief(LibBriefRequest request)
```
    delete face lib brief
    
    Parameters:
    
    request - brief request object.
    
    Returns:
    
    the final response object
  - delFaceImage
```
public LibResponse delFaceImage(String lib,
                                String brief,
                                String image)
```
    delete face lib image
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    image - image url.
    
    Returns:
    
    the final response object
  - delFaceImage
```
public LibResponse delFaceImage(LibImageRequest request)
```
    delete face lib image
    
    Parameters:
    
    request - face lib image request object.
    
    Returns:
    
    the final response object
  - getFaceLib
```
public LibBriefResponse getFaceLib(String lib)
```
    get face lib brief list
    
    Parameters:
    
    lib - lib name.
    
    Returns:
    
    brief list object.
  - getFaceLib
```
public LibBriefResponse getFaceLib(LibBriefRequest request)
```
    get face lib brief list
    
    Parameters:
    
    request - brief request object.
    
    Returns:
    
    brief list object.
  - getFaceBrief
```
public LibImageResponse getFaceBrief(String lib,
                                     String brief)
```
    get face lib image
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    Returns:
    
    image list object
  - getFaceBrief
```
public LibImageResponse getFaceBrief(LibBriefRequest request)
```
    get face lib image
    
    Parameters:
    
    request - face lib image request object.
    
    Returns:
    
    image list object
  - addLogoImage
```
public LibResponse addLogoImage(String lib,
                                String brief,
                                String image)
```
    add logo lib image
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    image - image url.
    
    Returns:
    
    the final response object
  - addLogoImage
```
public LibResponse addLogoImage(LibImageRequest request)
```
    add logo lib image
    
    Parameters:
    
    request - image request object.
    
    Returns:
    
    the final response object
  - delLogoBrief
```
public LibResponse delLogoBrief(String lib,
                                String brief)
```
    delete logo lib brief
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    Returns:
    
    the final response object
  - delLogoBrief
```
public LibResponse delLogoBrief(LibBriefRequest request)
```
    delete logo brief
    
    Parameters:
    
    request - brief request object.
    
    Returns:
    
    the final response object
  - delLogoImage
```
public LibResponse delLogoImage(String lib,
                                String image)
```
    delete logo lib image
    
    Parameters:
    
    lib - lib name.
    
    image - image url.
    
    Returns:
    
    the final response object
  - delLogoImage
```
public LibResponse delLogoImage(LibImageRequest request)
```
    delete logo lib image
    
    Parameters:
    
    request - image request object
    
    Returns:
    
    the final response object
  - getLogoLib
```
public LibBriefResponse getLogoLib(String lib)
```
    get logo lib brief list
    
    Parameters:
    
    lib - lib name
    
    Returns:
    
    brief list object
  - getLogoLib
```
public LibBriefResponse getLogoLib(LibBriefRequest request)
```
    get logo lib brief list
    
    Parameters:
    
    request - brief request object
    
    Returns:
    
    brief list object
  - getLogoBrief
```
public LibImageResponse getLogoBrief(String lib,
                                     String brief)
```
    get logo lib image list
    
    Parameters:
    
    lib - lib name.
    
    brief - brief name.
    
    Returns:
    
    image response object
  - getLogoBrief
```
public LibImageResponse getLogoBrief(LibBriefRequest request)
```
    get logo lib image list
    
    Parameters:
    
    request - brief request object.
    
    Returns:
    
    image response object

Class VcrClient

Field Summary

Fields inherited from class com.baidubce.AbstractBceClient

Constructor Summary

Method Summary

Methods inherited from class com.baidubce.AbstractBceClient

Methods inherited from class java.lang.Object

Constructor Detail

VcrClient

VcrClient

Method Detail

putMedia

putMedia

getMedia

getMedia

getMediaSpeech

getMediaSpeech

getMediaCharacter

getMediaCharacter

putStream

putStream

putStreamV2

cancelStreamV2

getStream

getStream

getStreamV2

getStreamV2

getStreamCheckTaskListV2

getStreamCheckTaskListV2

putAudio

putAudio

getAudio

getAudio

putImage

putImage

putImage

putImageAsync

putImageAsync

getImageAsync

getImageAsync

putText

putText

addFaceImage

addFaceImage

delFaceBrief

delFaceBrief

delFaceImage

delFaceImage

getFaceLib

getFaceLib

getFaceBrief

getFaceBrief

addLogoImage

addLogoImage

delLogoBrief

delLogoBrief

delLogoImage

delLogoImage

getLogoLib

getLogoLib

getLogoBrief

getLogoBrief