Package com.microsoft.azure.cognitiveservices.search.videosearch

Interface BingVideos

  • All Known Implementing Classes:
    BingVideosImpl
    public interface BingVideos
    An instance of this class provides access to all the operations defined in BingVideos.

    • Method Detail

      • search

        VideosModel search​(String query,
                   SearchOptionalParameter searchOptionalParameter)
        The Video Search API lets you send a search query to Bing and get back a list of videos that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
        Parameters:
        query - The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.
        searchOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the VideosModel object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • searchAsync

        rx.Observable<VideosModel> searchAsync​(String query,
                                       SearchOptionalParameter searchOptionalParameter)
        The Video Search API lets you send a search query to Bing and get back a list of videos that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
        Parameters:
        query - The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.
        searchOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the VideosModel object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • search

        BingVideos.BingVideosSearchDefinitionStages.WithQuery search()
        The Video Search API lets you send a search query to Bing and get back a list of videos that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
        Returns:
        the first stage of the search call

      • details

        VideoDetails details​(String query,
                     DetailsOptionalParameter detailsOptionalParameter)
        The Video Detail Search API lets you search on Bing and get back insights about a video, such as related videos. This section provides technical details about the query parameters and headers that you use to request insights of videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
        Parameters:
        query - The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.
        detailsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the VideoDetails object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • detailsAsync

        rx.Observable<VideoDetails> detailsAsync​(String query,
                                         DetailsOptionalParameter detailsOptionalParameter)
        The Video Detail Search API lets you search on Bing and get back insights about a video, such as related videos. This section provides technical details about the query parameters and headers that you use to request insights of videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
        Parameters:
        query - The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.
        detailsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the VideoDetails object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • details

        BingVideos.BingVideosDetailsDefinitionStages.WithQuery details()
        The Video Detail Search API lets you search on Bing and get back insights about a video, such as related videos. This section provides technical details about the query parameters and headers that you use to request insights of videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
        Returns:
        the first stage of the details call

      • trending

        TrendingVideos trending​(TrendingOptionalParameter trendingOptionalParameter)
        The Video Trending Search API lets you search on Bing and get back a list of videos that are trending based on search requests made by others. The videos are broken out into different categories. For example, Top Music Videos. For a list of markets that support trending videos, see [Trending Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/trending-videos).
        Parameters:
        trendingOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the TrendingVideos object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • trendingAsync

        rx.Observable<TrendingVideos> trendingAsync​(TrendingOptionalParameter trendingOptionalParameter)
        The Video Trending Search API lets you search on Bing and get back a list of videos that are trending based on search requests made by others. The videos are broken out into different categories. For example, Top Music Videos. For a list of markets that support trending videos, see [Trending Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/trending-videos).
        Parameters:
        trendingOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the TrendingVideos object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • trending

        BingVideos.BingVideosTrendingDefinitionStages.WithExecute trending()
        The Video Trending Search API lets you search on Bing and get back a list of videos that are trending based on search requests made by others. The videos are broken out into different categories. For example, Top Music Videos. For a list of markets that support trending videos, see [Trending Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/trending-videos).
        Returns:
        the first stage of the trending call