Pepper_47_C++_interfaces
Public Member Functions | List of all members
pp::RemoteControllerSamsung Class Reference

#include <remote_controller_samsung.h>

Collaboration diagram for pp::RemoteControllerSamsung:
Collaboration graph

Public Member Functions

 RemoteControllerSamsung (const InstanceHandle &instance)
 
int32_t RegisterKeys (uint32_t key_count, const char *keys[])
 
int32_t RegisterKeys (const std::vector< std::string > &keys)
 
int32_t UnRegisterKeys (uint32_t key_count, const char *keys[])
 
int32_t UnRegisterKeys (const std::vector< std::string > &keys)
 

Detailed Description

Definition at line 19 of file remote_controller_samsung.h.

Constructor & Destructor Documentation

pp::RemoteControllerSamsung::RemoteControllerSamsung ( const InstanceHandle instance)
explicit

A constructor for creating a RemoteControllerSamsung class for given instance of a module.

Definition at line 21 of file remote_controller_samsung.cc.

Member Function Documentation

int32_t pp::RemoteControllerSamsung::RegisterKeys ( uint32_t  key_count,
const char *  keys[] 
)

RegisterKeys() function registers given key arrays to be grabbed by the application/widget containing pepper plugin calling this method.

Note: After registering for grabbing keys, events related to that key will be delivered directly to the application/widget.

Note: For some embedders, we can`t tell if key that we try to register have failed because it have been already registered. So if at least one key have been successfully processed, we assume that other keys that failed, have been already registered before this call.

Parameters
[in]key_countA number of keys which will be grabbed.
[in]keysAn array containing list of keys which should be grabbed.
Returns
An int32_t containing an error code from pp_errors.h. Returns PP_ERROR_BADARGUMENT if key_count is equal 0 or one of keys is not supported anymore. Returns PP_ERROR_NOTSUPPORTED if currently launched embedder doesn`t support key registering. Returns PP_ERROR_FAILED if registering all keys have failed. Returns PP_OK if at lest one key from keys have been registered.

Definition at line 24 of file remote_controller_samsung.cc.

References pp::InstanceHandle::pp_instance().

Referenced by RegisterKeys().

int32_t pp::RemoteControllerSamsung::RegisterKeys ( const std::vector< std::string > &  keys)

RegisterKeys() function registers given key arrays to be grabbed by the application/widget containing pepper plugin calling this method.

Note: After registering for grabbing keys, events related to that key will be delivered directly to the application/widget.

Note: For some embedders, we can`t tell if key that we try to register have failed because it have been already registered. So if at least one key have been successfully processed, we assume that other keys that failed, have been already registered before this call.

Parameters
[in]keysA vector containing list of keys which should be grabbed.
Returns
An int32_t containing an error code from pp_errors.h. Returns PP_ERROR_BADARGUMENT if key_count is equal 0 or one of keys is not supported anymore. Returns PP_ERROR_NOTSUPPORTED if currently launched embedder doesn`t support key registering. Returns PP_ERROR_FAILED if registering all keys have failed. Returns PP_OK if at lest one key from keys have been registered.

Definition at line 33 of file remote_controller_samsung.cc.

References RegisterKeys().

int32_t pp::RemoteControllerSamsung::UnRegisterKeys ( uint32_t  key_count,
const char *  keys[] 
)

UnregisterKeys() function unregisters given key arrays from being grabbed by the application/widget containing pepper plugin calling this method.

Note: For some embedders, we can`t tell if key that we try to unregister have failed because it have been already unregistered. So if at least one key have been successfully processed, we assume that other keys that failed, have been already unregistered before this call.

Parameters
[in]key_countA number of keys which will be grabbed.
[in]keysAn array containing list of keys which should be grabbed.
Returns
An int32_t containing an error code from pp_errors.h. Returns PP_ERROR_BADARGUMENT if key_count is equal 0 or one of keys is not supported anymore. Returns PP_ERROR_NOTSUPPORTED if currently launched embedder doesn`t support key registering. Returns PP_ERROR_FAILED if registering all keys have failed. Returns PP_OK if at lest one key from keys have been registered.

Definition at line 42 of file remote_controller_samsung.cc.

References pp::InstanceHandle::pp_instance().

Referenced by UnRegisterKeys().

int32_t pp::RemoteControllerSamsung::UnRegisterKeys ( const std::vector< std::string > &  keys)

UnregisterKeys() function unregisters given key arrays from being grabbed by the application/widget containing pepper plugin calling this method.

Note: For some embedders, we can`t tell if key that we try to unregister have failed because it have been already unregistered. So if at least one key have been successfully processed, we assume that other keys that failed, have been already unregistered before this call.

Parameters
[in]keysA vector containing list of keys which should be grabbed.
Returns
An int32_t containing an error code from pp_errors.h. Returns PP_ERROR_BADARGUMENT if key_count is equal 0 or one of keys is not supported anymore. Returns PP_ERROR_NOTSUPPORTED if currently launched embedder doesn`t support key registering. Returns PP_ERROR_FAILED if registering all keys have failed. Returns PP_OK if at lest one key from keys have been registered.

Definition at line 51 of file remote_controller_samsung.cc.

References UnRegisterKeys().


The documentation for this class was generated from the following files: