mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2024-12-12 17:46:04 +01:00
240 lines
8.8 KiB
C
240 lines
8.8 KiB
C
// Copyright (c) 2017 Marshall A. Greenblatt. All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are
|
|
// met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
// in the documentation and/or other materials provided with the
|
|
// distribution.
|
|
// * Neither the name of Google Inc. nor the name Chromium Embedded
|
|
// Framework nor the names of its contributors may be used to endorse
|
|
// or promote products derived from this software without specific prior
|
|
// written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// ---------------------------------------------------------------------------
|
|
//
|
|
// This file was generated by the CEF translator tool and should not edited
|
|
// by hand. See the translator.README.txt file in the tools directory for
|
|
// more information.
|
|
//
|
|
|
|
#ifndef CEF_INCLUDE_CAPI_CEF_WEB_PLUGIN_CAPI_H_
|
|
#define CEF_INCLUDE_CAPI_CEF_WEB_PLUGIN_CAPI_H_
|
|
#pragma once
|
|
|
|
#include "include/capi/cef_base_capi.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct _cef_browser_t;
|
|
|
|
///
|
|
// Information about a specific web plugin.
|
|
///
|
|
typedef struct _cef_web_plugin_info_t {
|
|
///
|
|
// Base structure.
|
|
///
|
|
cef_base_t base;
|
|
|
|
///
|
|
// Returns the plugin name (i.e. Flash).
|
|
///
|
|
// The resulting string must be freed by calling cef_string_userfree_free().
|
|
cef_string_userfree_t (CEF_CALLBACK *get_name)(
|
|
struct _cef_web_plugin_info_t* self);
|
|
|
|
///
|
|
// Returns the plugin file path (DLL/bundle/library).
|
|
///
|
|
// The resulting string must be freed by calling cef_string_userfree_free().
|
|
cef_string_userfree_t (CEF_CALLBACK *get_path)(
|
|
struct _cef_web_plugin_info_t* self);
|
|
|
|
///
|
|
// Returns the version of the plugin (may be OS-specific).
|
|
///
|
|
// The resulting string must be freed by calling cef_string_userfree_free().
|
|
cef_string_userfree_t (CEF_CALLBACK *get_version)(
|
|
struct _cef_web_plugin_info_t* self);
|
|
|
|
///
|
|
// Returns a description of the plugin from the version information.
|
|
///
|
|
// The resulting string must be freed by calling cef_string_userfree_free().
|
|
cef_string_userfree_t (CEF_CALLBACK *get_description)(
|
|
struct _cef_web_plugin_info_t* self);
|
|
} cef_web_plugin_info_t;
|
|
|
|
|
|
///
|
|
// Structure to implement for visiting web plugin information. The functions of
|
|
// this structure will be called on the browser process UI thread.
|
|
///
|
|
typedef struct _cef_web_plugin_info_visitor_t {
|
|
///
|
|
// Base structure.
|
|
///
|
|
cef_base_t base;
|
|
|
|
///
|
|
// Method that will be called once for each plugin. |count| is the 0-based
|
|
// index for the current plugin. |total| is the total number of plugins.
|
|
// Return false (0) to stop visiting plugins. This function may never be
|
|
// called if no plugins are found.
|
|
///
|
|
int (CEF_CALLBACK *visit)(struct _cef_web_plugin_info_visitor_t* self,
|
|
struct _cef_web_plugin_info_t* info, int count, int total);
|
|
} cef_web_plugin_info_visitor_t;
|
|
|
|
|
|
///
|
|
// Structure to implement for receiving unstable plugin information. The
|
|
// functions of this structure will be called on the browser process IO thread.
|
|
///
|
|
typedef struct _cef_web_plugin_unstable_callback_t {
|
|
///
|
|
// Base structure.
|
|
///
|
|
cef_base_t base;
|
|
|
|
///
|
|
// Method that will be called for the requested plugin. |unstable| will be
|
|
// true (1) if the plugin has reached the crash count threshold of 3 times in
|
|
// 120 seconds.
|
|
///
|
|
void (CEF_CALLBACK *is_unstable)(
|
|
struct _cef_web_plugin_unstable_callback_t* self,
|
|
const cef_string_t* path, int unstable);
|
|
} cef_web_plugin_unstable_callback_t;
|
|
|
|
|
|
///
|
|
// Implement this structure to receive notification when CDM registration is
|
|
// complete. The functions of this structure will be called on the browser
|
|
// process UI thread.
|
|
///
|
|
typedef struct _cef_register_cdm_callback_t {
|
|
///
|
|
// Base structure.
|
|
///
|
|
cef_base_t base;
|
|
|
|
///
|
|
// Method that will be called when CDM registration is complete. |result| will
|
|
// be CEF_CDM_REGISTRATION_ERROR_NONE if registration completed successfully.
|
|
// Otherwise, |result| and |error_message| will contain additional information
|
|
// about why registration failed.
|
|
///
|
|
void (CEF_CALLBACK *on_cdm_registration_complete)(
|
|
struct _cef_register_cdm_callback_t* self,
|
|
cef_cdm_registration_error_t result, const cef_string_t* error_message);
|
|
} cef_register_cdm_callback_t;
|
|
|
|
|
|
///
|
|
// Visit web plugin information. Can be called on any thread in the browser
|
|
// process.
|
|
///
|
|
CEF_EXPORT void cef_visit_web_plugin_info(
|
|
cef_web_plugin_info_visitor_t* visitor);
|
|
|
|
///
|
|
// Cause the plugin list to refresh the next time it is accessed regardless of
|
|
// whether it has already been loaded. Can be called on any thread in the
|
|
// browser process.
|
|
///
|
|
CEF_EXPORT void cef_refresh_web_plugins();
|
|
|
|
///
|
|
// Unregister an internal plugin. This may be undone the next time
|
|
// cef_refresh_web_plugins() is called. Can be called on any thread in the
|
|
// browser process.
|
|
///
|
|
CEF_EXPORT void cef_unregister_internal_web_plugin(const cef_string_t* path);
|
|
|
|
///
|
|
// Register a plugin crash. Can be called on any thread in the browser process
|
|
// but will be executed on the IO thread.
|
|
///
|
|
CEF_EXPORT void cef_register_web_plugin_crash(const cef_string_t* path);
|
|
|
|
///
|
|
// Query if a plugin is unstable. Can be called on any thread in the browser
|
|
// process.
|
|
///
|
|
CEF_EXPORT void cef_is_web_plugin_unstable(const cef_string_t* path,
|
|
cef_web_plugin_unstable_callback_t* callback);
|
|
|
|
///
|
|
// Register the Widevine CDM plugin.
|
|
//
|
|
// The client application is responsible for downloading an appropriate
|
|
// platform-specific CDM binary distribution from Google, extracting the
|
|
// contents, and building the required directory structure on the local machine.
|
|
// The cef_browser_host_t::StartDownload function and CefZipArchive structure
|
|
// can be used to implement this functionality in CEF. Contact Google via
|
|
// https://www.widevine.com/contact.html for details on CDM download.
|
|
//
|
|
// |path| is a directory that must contain the following files:
|
|
// 1. manifest.json file from the CDM binary distribution (see below).
|
|
// 2. widevinecdm file from the CDM binary distribution (e.g.
|
|
// widevinecdm.dll on on Windows, libwidevinecdm.dylib on OS X,
|
|
// libwidevinecdm.so on Linux).
|
|
// 3. widevidecdmadapter file from the CEF binary distribution (e.g.
|
|
// widevinecdmadapter.dll on Windows, widevinecdmadapter.plugin on OS X,
|
|
// libwidevinecdmadapter.so on Linux).
|
|
//
|
|
// If any of these files are missing or if the manifest file has incorrect
|
|
// contents the registration will fail and |callback| will receive a |result|
|
|
// value of CEF_CDM_REGISTRATION_ERROR_INCORRECT_CONTENTS.
|
|
//
|
|
// The manifest.json file must contain the following keys:
|
|
// A. "os": Supported OS (e.g. "mac", "win" or "linux").
|
|
// B. "arch": Supported architecture (e.g. "ia32" or "x64").
|
|
// C. "x-cdm-module-versions": Module API version (e.g. "4").
|
|
// D. "x-cdm-interface-versions": Interface API version (e.g. "8").
|
|
// E. "x-cdm-host-versions": Host API version (e.g. "8").
|
|
// F. "version": CDM version (e.g. "1.4.8.903").
|
|
// G. "x-cdm-codecs": List of supported codecs (e.g. "vp8,vp9.0,avc1").
|
|
//
|
|
// A through E are used to verify compatibility with the current Chromium
|
|
// version. If the CDM is not compatible the registration will fail and
|
|
// |callback| will receive a |result| value of
|
|
// CEF_CDM_REGISTRATION_ERROR_INCOMPATIBLE.
|
|
//
|
|
// |callback| will be executed asynchronously once registration is complete.
|
|
//
|
|
// On Linux this function must be called before cef_initialize() and the
|
|
// registration cannot be changed during runtime. If registration is not
|
|
// supported at the time that cef_register_widevine_cdm() is called then
|
|
// |callback| will receive a |result| value of
|
|
// CEF_CDM_REGISTRATION_ERROR_NOT_SUPPORTED.
|
|
///
|
|
CEF_EXPORT void cef_register_widevine_cdm(const cef_string_t* path,
|
|
cef_register_cdm_callback_t* callback);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // CEF_INCLUDE_CAPI_CEF_WEB_PLUGIN_CAPI_H_
|