Edit

Share via

Quickstart: Use the Bing Video Search Java client library

  • Article

Use this quickstart to begin searching for news with the Bing Video Search client library for Java. While Bing Video Search has a REST API compatible with most programming languages, the client library provides an easy way to integrate the service into your applications. The source code for this sample can be found on GitHub, with additional annotations, and features.

Prerequisites

Install the Bing Video Search client library dependencies by using Maven, Gradle, or another dependency management system. The Maven POM file requires the following declaration:

  <dependencies>
    <dependency>
      <groupId>com.microsoft.azure.cognitiveservices</groupId>
      <artifactId>azure-cognitiveservices-videosearch</artifactId>
      <version>0.0.1-beta-SNAPSHOT</version>
    </dependency>
  </dependencies>

Create and initialize a project

Create a new Java project in your favorite IDE or editor, and import the following libraries.

    import com.microsoft.azure.cognitiveservices.videosearch.*;
    import com.microsoft.azure.cognitiveservices.videosearch.VideoObject;
    import com.microsoft.rest.credentials.ServiceClientCredentials;
    import okhttp3.Interceptor;
    import okhttp3.OkHttpClient;
    import okhttp3.Request;
    import okhttp3.Response;
    import java.io.IOException;
    import java.util.ArrayList;
    import java.util.List;

Create a search client

  1. Implement the VideoSearchAPIImpl client, which requires your API endpoint, and an instance of the ServiceClientCredentials class.

    public static VideoSearchAPIImpl getClient(final String subscriptionKey) {
    return new VideoSearchAPIImpl("https://api.bing.microsoft.com/bing/v7.0/",
            new ServiceClientCredentials() {
            //...
            }
)};

    To implement ServiceClientCredentials, follow these steps:

    1. Override the applyCredentialsFilter() function, with a OkHttpClient.Builder object as a parameter.

      //...
new ServiceClientCredentials() {
        @Override
        public void applyCredentialsFilter(OkHttpClient.Builder builder) {
        //...
        }
//...

    2. Within applyCredentialsFilter(), call builder.addNetworkInterceptor(). Create a new Interceptor object, and override its intercept() method to take a Chain interceptor object.

      //...
builder.addNetworkInterceptor(
    new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
        //...    
        }
    });
///...

    3. Within the intercept function, create variables for your request. Use Request.Builder() to build your request. Add your subscription key to the Ocp-Apim-Subscription-Key header, and return chain.proceed() on the request object.

      //...
public Response intercept(Chain chain) throws IOException {
    Request request = null;
    Request original = chain.request();
    Request.Builder requestBuilder = original.newBuilder()
            .addHeader("Ocp-Apim-Subscription-Key", subscriptionKey);
    request = requestBuilder.build();
    return chain.proceed(request);
}
//...

Send a search request and receive the response

  1. Create a function called VideoSearch() that takes your subscription key as a string. Instantiate the search client created earlier.

    public static void VideoSearch(String subscriptionKey){
    VideoSearchAPIImpl client = VideoSDK.getClient(subscriptionKey);
    //...
}

  2. Within VideoSearch(), Send a video search request using the client, with SwiftKey as the search term. If the Video Search API returned a result, get the first result and print its id, name, and URL, along with the total number of videos returned.

    VideosInner videoResults = client.searchs().list("SwiftKey");

if (videoResults == null){
    System.out.println("Didn't see any video result data..");
}
else{
    if (videoResults.value().size() > 0){
        VideoObject firstVideoResult = videoResults.value().get(0);

        System.out.println(String.format("Video result count: %d", videoResults.value().size()));
        System.out.println(String.format("First video id: %s", firstVideoResult.videoId()));
        System.out.println(String.format("First video name: %s", firstVideoResult.name()));
        System.out.println(String.format("First video url: %s", firstVideoResult.contentUrl()));
    }
    else{
        System.out.println("Couldn't find video results!");
    }
}

  3. Call the search method from your main method.

    public static void main(String[] args) {
    VideoSDK.VideoSearch("YOUR-SUBSCRIPTION-KEY");
}

Next steps

Create a single page web app

See also