Pepper_47_C_interfaces
Typedefs | Functions
Typedefs

Typedefs

typedef void(* PPB_AudioInput_Callback )(const void *sample_buffer, uint32_t buffer_size_in_bytes, PP_TimeDelta latency, void *user_data)
 
typedef void(* PPB_AudioInput_Callback_0_3 )(const void *sample_buffer, uint32_t buffer_size_in_bytes, void *user_data)
 
typedef void(* PP_MonitorDeviceChangeCallback )(void *user_data, uint32_t device_count, const PP_Resource devices[])
 
typedef void *(* PP_ArrayOutput_GetDataBuffer )(void *user_data, uint32_t element_count, uint32_t element_size)
 
typedef void(* PP_CompletionCallback_Func )(void *user_data, int32_t result)
 
typedef int32_t PP_Instance
 
typedef int32_t PP_Module
 
typedef int32_t PP_Resource
 
typedef double PP_Time
 
typedef double PP_TimeTicks
 
typedef double PP_TimeDelta
 
typedef const void *(* PPB_GetInterface )(const char *interface_name)
 
typedef void(* PPB_Audio_Callback )(void *sample_buffer, uint32_t buffer_size_in_bytes, PP_TimeDelta latency, void *user_data)
 
typedef void(* PPB_Audio_Callback_1_0 )(void *sample_buffer, uint32_t buffer_size_in_bytes, void *user_data)
 
typedef int32_t(* PP_InitializeModule_Func )(PP_Module module, PPB_GetInterface get_browser_interface)
 
typedef void(* PP_ShutdownModule_Func )(void)
 
typedef const void *(* PP_GetInterface_Func )(const char *interface_name)
 
typedef void(* PPB_Flash_BrowserOperations_GetSettingsCallback )(void *user_data, PP_Bool success, PP_Flash_BrowserOperations_Permission default_permission, uint32_t site_count, const struct PP_Flash_BrowserOperations_SiteSetting sites[])
 
typedef int64_t PP_MicrosecondsDelta
 
typedef void(* PP_URLLoaderTrusted_StatusCallback )(PP_Instance pp_instance, PP_Resource pp_resource, int64_t bytes_sent, int64_t total_bytes_to_be_sent, int64_t bytes_received, int64_t total_bytes_to_be_received)
 
typedef int32_t(* PP_ConnectInstance_Func )(PP_Instance instance, int32_t handle)
 

Functions

 PP_COMPILE_ASSERT_SIZE_IN_BYTES (PP_Instance, 4)
 
 PP_COMPILE_ASSERT_SIZE_IN_BYTES (PP_Time, 8)
 
 PP_COMPILE_ASSERT_SIZE_IN_BYTES (PP_MicrosecondsDelta, 8)
 

Detailed Description

Typedef Documentation

typedef void*(* PP_ArrayOutput_GetDataBuffer)(void *user_data, uint32_t element_count, uint32_t element_size)

Definition at line 57 of file pp_array_output.h.

typedef void(* PP_CompletionCallback_Func)(void *user_data, int32_t result)

This typedef defines the signature that you implement to receive callbacks on asynchronous completion of an operation.

Parameters
[in]user_dataA pointer to user data passed to a callback function.
[in]resultIf result is 0 (PP_OK), the operation succeeded. Negative values (other than -1 or PP_OK_COMPLETE) indicate error and are specified in pp_errors.h. Positive values for result usually indicate success and have some operation-dependent meaning (such as bytes read).

Definition at line 34 of file pp_completion_callback.h.

typedef int32_t(* PP_ConnectInstance_Func)(PP_Instance instance, int32_t handle)

PP_ConnectInstance_Func defines the signature that you implement to receive notifications when a plugin instance connects to the broker. The broker should listen on the socket before returning.

Parameters
[in]instanceThe plugin instance connecting to the broker.
[in]handleHandle to a socket the broker can use to communicate with the plugin.
Returns
PP_OK on success. Any other value on failure.

Definition at line 57 of file ppp_broker.h.

typedef const void*(* PP_GetInterface_Func)(const char *interface_name)

Defines the type of the PPP_ShutdownModule function.

Definition at line 153 of file ppp.h.

typedef int32_t(* PP_InitializeModule_Func)(PP_Module module, PPB_GetInterface get_browser_interface)

Defines the type of the PPP_InitializeModule function.

Definition at line 141 of file ppp.h.

typedef int32_t PP_Instance

The PP_Instance value uniquely identifies one instance of a module (.nexe/PP_Module). There will be one module instance for every <embed> tag on a page.

This identifier is an opaque handle assigned by the browser to the module. It is guaranteed never to be 0, so a module can initialize it to 0 to indicate a "NULL handle."

Definition at line 34 of file pp_instance.h.

typedef int64_t PP_MicrosecondsDelta

Definition at line 25 of file pp_media_common_samsung.h.

typedef int32_t PP_Module

The PP_Module value uniquely identifies the module or .nexe.

This identifier is an opaque handle assigned by the browser to the module. It is guaranteed never to be 0, so a module can initialize it to 0 to indicate a "NULL handle."

Definition at line 32 of file pp_module.h.

typedef void(* PP_MonitorDeviceChangeCallback)(void *user_data, uint32_t device_count, const PP_Resource devices[])

Defines the callback type to receive device change notifications for PPB_AudioInput_Dev.MonitorDeviceChange() and PPB_VideoCapture_Dev.MonitorDeviceChange().

Parameters
[in,out]user_dataThe opaque pointer that the caller passed into MonitorDeviceChange().
[in]device_countHow many devices in the array.
[in]devicesAn array of PPB_DeviceRef_Dev. Please note that the ref count of the elements is not increased on behalf of the plugin.

Definition at line 41 of file ppb_device_ref_dev.h.

typedef int32_t PP_Resource

This typedef represents an opaque handle assigned by the browser to the resource. The handle is guaranteed never to be 0 for a valid resource, so a module can initialize it to 0 to indicate a "NULL handle." Some interfaces may return a NULL resource to indicate failure.

While a Var represents something callable to JS or from the module to the DOM, a resource has no meaning or visibility outside of the module interface.

Resources are reference counted. Use AddRefResource() and ReleaseResource() in ppb_core.h to manage the reference count of a resource. The data will be automatically destroyed when the internal reference count reaches 0.

Definition at line 40 of file pp_resource.h.

typedef void(* PP_ShutdownModule_Func)(void)

Defines the type of the PPP_ShutdownModule function.

Definition at line 148 of file ppp.h.

typedef double PP_Time

The PP_Time type represents the "wall clock time" according to the browser and is defined as the number of seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Definition at line 29 of file pp_time.h.

typedef double PP_TimeDelta

A PP_TimeDelta value represents a duration of time which is measured in seconds.

Definition at line 49 of file pp_time.h.

typedef double PP_TimeTicks

A PP_TimeTicks value represents time ticks which are measured in seconds and are used for indicating the time that certain messages were received. In contrast to PP_Time, PP_TimeTicks does not correspond to any actual wall clock time and will not change discontinuously if the user changes their computer clock.

The units are in seconds, but are not measured relative to any particular epoch, so the most you can do is compare two values.

Definition at line 42 of file pp_time.h.

typedef void(* PP_URLLoaderTrusted_StatusCallback)(PP_Instance pp_instance, PP_Resource pp_resource, int64_t bytes_sent, int64_t total_bytes_to_be_sent, int64_t bytes_received, int64_t total_bytes_to_be_received)

Callback that indicates the status of the download and upload for the given URLLoader resource.

Definition at line 32 of file ppb_url_loader_trusted.h.

typedef void(* PPB_Audio_Callback)(void *sample_buffer, uint32_t buffer_size_in_bytes, PP_TimeDelta latency, void *user_data)

PPB_Audio_Callback defines the type of an audio callback function used to fill the audio buffer with data. Please see the Create() function in the PPB_Audio interface for more details on this callback.

Parameters
[in]sample_bufferA buffer to fill with audio data.
[in]buffer_size_in_bytesThe size of the buffer in bytes.
[in]latencyHow long before the audio data is to be presented.
[in,out]user_dataAn opaque pointer that was passed into PPB_Audio.Create().

Definition at line 45 of file ppb_audio.h.

typedef void(* PPB_Audio_Callback_1_0)(void *sample_buffer, uint32_t buffer_size_in_bytes, void *user_data)

Definition at line 50 of file ppb_audio.h.

typedef void(* PPB_AudioInput_Callback)(const void *sample_buffer, uint32_t buffer_size_in_bytes, PP_TimeDelta latency, void *user_data)

PPB_AudioInput_Callback defines the type of an audio callback function used to provide the audio buffer with data. This callback will be called on a separate thread from the creation thread.

Parameters
[in]sample_bufferA buffer providing audio input data.
[in]buffer_size_in_bytesThe size of the buffer in bytes.
[in]latencyThe time that has elapsed since the data was recorded.
[in,out]user_dataAn opaque pointer that was passed into PPB_AudioInput_Dev.Open().

Definition at line 47 of file ppb_audio_input_dev.h.

typedef void(* PPB_AudioInput_Callback_0_3)(const void *sample_buffer, uint32_t buffer_size_in_bytes, void *user_data)

Definition at line 52 of file ppb_audio_input_dev.h.

typedef void(* PPB_Flash_BrowserOperations_GetSettingsCallback)(void *user_data, PP_Bool success, PP_Flash_BrowserOperations_Permission default_permission, uint32_t site_count, const struct PP_Flash_BrowserOperations_SiteSetting sites[])

Definition at line 70 of file ppp_flash_browser_operations.h.

typedef const void*(* PPB_GetInterface)(const char *interface_name)

This function pointer type defines the signature for the PPB_GetInterface function. A generic PPB_GetInterface pointer is passed to PPP_InitializedModule when your module is loaded. You can use this pointer to request a pointer to a specific browser interface. Browser interface names are ASCII strings and are generally defined in the header file for the interface, such as PPB_AUDIO_INTERFACE found in ppb.audio.h or PPB_GRAPHICS_2D_INTERFACE in ppb_graphics_2d.h. Click here for a complete list of interface names.

This value will be NULL if the interface is not supported on the browser.

Definition at line 42 of file ppb.h.

Function Documentation

PP_COMPILE_ASSERT_SIZE_IN_BYTES ( PP_MicrosecondsDelta  ,
 
)
PP_COMPILE_ASSERT_SIZE_IN_BYTES ( PP_Time  ,
 
)
PP_COMPILE_ASSERT_SIZE_IN_BYTES ( PP_Instance  ,
 
)