#include <ppb_video_destination_private.h>

Collaboration diagram for PPB_VideoDestination_Private_0_1:

Public Attributes
PP_Resource(*	Create )(PP_Instance instance)

PP_Bool(*	IsVideoDestination )(PP_Resource resource)

int32_t(*	Open )(PP_Resource destination, struct PP_Var stream_url, struct PP_CompletionCallback callback)

int32_t(*	PutFrame )(PP_Resource destination, const struct PP_VideoFrame_Private *frame)

void(*	Close )(PP_Resource destination)

Detailed Description

The PPB_VideoDestination_Private interface contains pointers to several functions for creating video destination resources and using them to send video frames to a MediaStream video track in the browser.

Definition at line 45 of file ppb_video_destination_private.h.

Member Data Documentation

void(* PPB_VideoDestination_Private_0_1::Close)(PP_Resource destination)

Closes the video destination.

Parameters

[in] destination A PP_Resource corresponding to a video destination.

Definition at line 113 of file ppb_video_destination_private.h.

PP_Resource(* PPB_VideoDestination_Private_0_1::Create)(PP_Instance instance)

Creates a video destination resource.

Parameters

[in] instance A PP_Instance identifying an instance of a module.

Returns: A PP_Resource with a nonzero ID on success or zero on failure. Failure means the instance was invalid.

Definition at line 55 of file ppb_video_destination_private.h.

PP_Bool(* PPB_VideoDestination_Private_0_1::IsVideoDestination)(PP_Resource resource)

Determines if a resource is a video destination resource.

Parameters

[in] resource The PP_Resource to test.

Returns: A PP_Bool with PP_TRUE if the given resource is a video destination resource or PP_FALSE otherwise.

Definition at line 65 of file ppb_video_destination_private.h.

int32_t(* PPB_VideoDestination_Private_0_1::Open)(PP_Resource destination, struct PP_Var stream_url, struct PP_CompletionCallback callback)

Opens a video destination for putting frames.

Parameters

[in]	destination	A `PP_Resource` corresponding to a video destination resource.
[in]	stream_url	A `PP_Var` string holding a URL identifying a MediaStream.
[in]	callback	A `PP_CompletionCallback` to be called upon completion of Open().

Returns: An int32_t containing a result code from pp_errors.h. Returns PP_ERROR_BADRESOURCE if destination isn't a valid video destination. Returns PP_ERROR_INPROGRESS if destination is already open. Returns PP_ERROR_FAILED if the MediaStream doesn't exist or if there is some other browser error.

Definition at line 83 of file ppb_video_destination_private.h.

int32_t(* PPB_VideoDestination_Private_0_1::PutFrame)(PP_Resource destination, const struct PP_VideoFrame_Private *frame)

Puts a frame to the video destination.

After this call, you should take care to release your references to the image embedded in the video frame. If you paint to the image after PutFame(), there is the possibility of artifacts because the browser may still be copying the frame to the stream.

Parameters

[in]	destination	A `PP_Resource` corresponding to a video destination resource.
[in]	frame	A `PP_VideoFrame_Private` holding the video frame to send to the destination.

Returns: An int32_t containing a result code from pp_errors.h. Returns PP_ERROR_BADRESOURCE if destination isn't a valid video destination. Returns PP_ERROR_FAILED if destination is not open, if the video frame has an invalid image data resource, or if some other browser error occurs.

Definition at line 105 of file ppb_video_destination_private.h.

The documentation for this struct was generated from the following file:

private/ppb_video_destination_private.h

Public Attributes

Detailed Description

Member Data Documentation