chenqiyang
2022-09-02 6a99d9bf65aa5878cb409945ed2bdbdcb916d047
HDLLinPhoneSDK(OC)/HDLLinPhoneSDK/linphone-sdk/apple-darwin/Frameworks/linphone.framework/Headers/player.h
old mode 100644 new mode 100755
@@ -37,163 +37,182 @@
/**
 * Acquire a reference to the player.
 * @param[in] player #LinphonePlayer object.
 * @return The same #LinphonePlayer object.
 * @param player #LinphonePlayer object. @notnil
 * @return The same #LinphonePlayer object. @notnil
**/
LINPHONE_PUBLIC LinphonePlayer * linphone_player_ref(LinphonePlayer *player);
/**
 * Release reference to the player.
 * @param[in] player #LinphonePlayer object.
 * @param player #LinphonePlayer object. @notnil
**/
LINPHONE_PUBLIC void linphone_player_unref(LinphonePlayer *player);
/**
 * Retrieve the user pointer associated with the player.
 * @param[in] player #LinphonePlayer object.
 * @return The user pointer associated with the player.
 * @param player #LinphonePlayer object. @notnil
 * @return The user pointer associated with the player. @maybenil
**/
LINPHONE_PUBLIC void *linphone_player_get_user_data(const LinphonePlayer *player);
/**
 * Assign a user pointer to the player.
 * @param[in] player #LinphonePlayer object.
 * @param[in] ud The user pointer to associate with the player.
 * @param player #LinphonePlayer object. @notnil
 * @param user_data The user pointer to associate with the player. @maybenil
**/
LINPHONE_PUBLIC void linphone_player_set_user_data(LinphonePlayer *player, void *ud);
/**
 * Get the #LinphonePlayerCbs object associated with the LinphonePlayer.
 * @param[in] player #LinphonePlayer object
 * @return The #LinphonePlayerCbs object associated with the LinphonePlayer.
 * @deprecated use add_callbacks / remove_callbacks instead
 */
LINPHONE_PUBLIC LinphonePlayerCbs * linphone_player_get_callbacks(const LinphonePlayer *player);
LINPHONE_PUBLIC void linphone_player_set_user_data(LinphonePlayer *player, void *user_data);
/**
 * Adds a #LinphonePlayerCbs object associated to the LinphonePlayer.
 * @param[in] player #LinphonePlayer object
 * @param[in] cbs The #LinphonePlayerCbs object to be added to the LinphonePlayer.
 * @param player #LinphonePlayer object @notnil
 * @param cbs The #LinphonePlayerCbs object to be added to the LinphonePlayer. @notnil
 */
LINPHONE_PUBLIC void linphone_player_add_callbacks(LinphonePlayer *player, LinphonePlayerCbs *cbs);
/**
 * Removes a #LinphonePlayerCbs object associated to the LinphonePlayer.
 * @param[in] player #LinphonePlayer object
 * @param[in] cbs The #LinphonePlayerCbs object to be removed from the LinphonePlayer.
 * @param player #LinphonePlayer object @notnil
 * @param cbs The #LinphonePlayerCbs object to be removed from the LinphonePlayer. @notnil
 */
LINPHONE_PUBLIC void linphone_player_remove_callbacks(LinphonePlayer *player, LinphonePlayerCbs *cbs);
/**
 * Returns the current LinphonePlayerCbsCbs object
 * @param[in] player #LinphonePlayer object
 * @return The current #LinphonePlayerCbs object
 * @param player #LinphonePlayer object @notnil
 * @return The current #LinphonePlayerCbs object @maybenil
 */
LINPHONE_PUBLIC LinphonePlayerCbs *linphone_player_get_current_callbacks(const LinphonePlayer *player);
/**
 * Open a file for playing.
 * @param[in] obj #LinphonePlayer object
 * @param[in] filename The path to the file to open
 * @param player #LinphonePlayer object @notnil
 * @param filename The path to the file to open @notnil
 */
LINPHONE_PUBLIC LinphoneStatus linphone_player_open(LinphonePlayer *obj, const char *filename);
LINPHONE_PUBLIC LinphoneStatus linphone_player_open(LinphonePlayer *player, const char *filename);
/**
 * Start playing a file that has been opened with linphone_player_open().
 * @param[in] obj #LinphonePlayer object
 * @param player #LinphonePlayer object @notnil
 * @return 0 on success, a negative value otherwise
 */
LINPHONE_PUBLIC LinphoneStatus linphone_player_start(LinphonePlayer *obj);
LINPHONE_PUBLIC LinphoneStatus linphone_player_start(LinphonePlayer *player);
/**
 * Pause the playing of a file.
 * @param[in] obj #LinphonePlayer object
 * @param player #LinphonePlayer object @notnil
 * @return 0 on success, a negative value otherwise
 */
LINPHONE_PUBLIC LinphoneStatus linphone_player_pause(LinphonePlayer *obj);
LINPHONE_PUBLIC LinphoneStatus linphone_player_pause(LinphonePlayer *player);
/**
 * Seek in an opened file.
 * @param[in] obj #LinphonePlayer object
 * @param[in] time_ms The time we want to go to in the file (in milliseconds).
 * @param player #LinphonePlayer object @notnil
 * @param time_ms The time we want to go to in the file (in milliseconds).
 * @return 0 on success, a negative value otherwise.
 */
LINPHONE_PUBLIC LinphoneStatus linphone_player_seek(LinphonePlayer *obj, int time_ms);
LINPHONE_PUBLIC LinphoneStatus linphone_player_seek(LinphonePlayer *player, int time_ms);
/**
 * Get the current state of a player.
 * @param[in] obj #LinphonePlayer object
 * @return The current state of the player.
 * @param player #LinphonePlayer object @notnil
 * @return The current #LinphonePlayerState of the player.
 */
LINPHONE_PUBLIC LinphonePlayerState linphone_player_get_state(LinphonePlayer *obj);
LINPHONE_PUBLIC LinphonePlayerState linphone_player_get_state(LinphonePlayer *player);
/**
 * Get the duration of the opened file.
 * @param[in] obj #LinphonePlayer object
 * @param player #LinphonePlayer object @notnil
 * @return The duration of the opened file
 */
LINPHONE_PUBLIC int linphone_player_get_duration(LinphonePlayer *obj);
LINPHONE_PUBLIC int linphone_player_get_duration(LinphonePlayer *player);
/**
 * Get the current position in the opened file.
 * @param[in] obj #LinphonePlayer object
 * @param player #LinphonePlayer object @notnil
 * @return The current position in the opened file
 */
LINPHONE_PUBLIC int linphone_player_get_current_position(LinphonePlayer *obj);
LINPHONE_PUBLIC int linphone_player_get_current_position(LinphonePlayer *player);
/**
 * Close the opened file.
 * @param[in] obj #LinphonePlayer object
 * @param player #LinphonePlayer object @notnil
 */
LINPHONE_PUBLIC void linphone_player_close(LinphonePlayer *obj);
LINPHONE_PUBLIC void linphone_player_close(LinphonePlayer *player);
/**
 * Sets a window id to be used to display video if any.
 * @param player #LinphonePlayer object @notnil
 * @param window_id The window id pointer to use. @maybenil
 */
LINPHONE_PUBLIC void linphone_player_set_window_id(LinphonePlayer *player, void *window_id);
/**
 * Returns whether the file has video and if it can be displayed
 * @param player #LinphonePlayer object @notnil
 * @return TRUE if file has video and it can be displayed, FALSE otherwise
 */
LINPHONE_PUBLIC bool_t linphone_player_get_is_video_available(LinphonePlayer *player);
/**
 * Returns the #LinphoneCore object managing this player's call, if any.
 * @param[in] fr #LinphonePlayer object
 * @param player #LinphonePlayer object @notnil
 * @return the #LinphoneCore object associated @notnil
 */
LINPHONE_PUBLIC LinphoneCore *linphone_player_get_core(const LinphonePlayer *player);
/**
 * Acquire a reference to the #LinphonePlayerCbs object.
 * @param[in] cbs #LinphonePlayerCbs object.
 * @return The same #LinphonePlayerCbs object.
 * @param cbs #LinphonePlayerCbs object. @notnil
 * @return The same #LinphonePlayerCbs object. @notnil
 */
LINPHONE_PUBLIC LinphonePlayerCbs * linphone_player_cbs_ref(LinphonePlayerCbs *cbs);
/**
 * Release reference to the #LinphonePlayerCbs object.
 * @param[in] cbs #LinphonePlayerCbs object.
 * @param cbs #LinphonePlayerCbs object. @notnil
 */
LINPHONE_PUBLIC void linphone_player_cbs_unref(LinphonePlayerCbs *cbs);
/**
 * Retrieve the user pointer associated with the #LinphonePlayerCbs object.
 * @param[in] cbs #LinphonePlayerCbs object.
 * @return The user pointer associated with the #LinphonePlayerCbs object.
 * @param cbs #LinphonePlayerCbs object. @notnil
 * @return The user pointer associated with the #LinphonePlayerCbs object. @maybenil
 */
LINPHONE_PUBLIC void *linphone_player_cbs_get_user_data(const LinphonePlayerCbs *cbs);
/**
 * Assign a user pointer to the #LinphonePlayerCbs object.
 * @param[in] cbs #LinphonePlayerCbs object.
 * @param[in] ud The user pointer to associate with the #LinphonePlayerCbs object.
 * @param cbs #LinphonePlayerCbs object. @notnil
 * @param user_data The user pointer to associate with the #LinphonePlayerCbs object. @maybenil
 */
LINPHONE_PUBLIC void linphone_player_cbs_set_user_data(LinphonePlayerCbs *cbs, void *ud);
LINPHONE_PUBLIC void linphone_player_cbs_set_user_data(LinphonePlayerCbs *cbs, void *user_data);
/**
 * Get the end-of-file reached callback.
 * @param[in] cbs #LinphonePlayerCbs object.
 * @param cbs #LinphonePlayerCbs object. @notnil
 * @return The current end-of-file reached callback.
 */
LINPHONE_PUBLIC LinphonePlayerCbsEofReachedCb linphone_player_cbs_get_eof_reached(const LinphonePlayerCbs *cbs);
/**
 * Set the end-of-file reached callback.
 * @param[in] cbs #LinphonePlayerCbs object.
 * @param[in] cb The end-of-file reached callback to be used.
 * @param cbs #LinphonePlayerCbs object. @notnil
 * @param cb The end-of-file reached callback to be used.
 */
LINPHONE_PUBLIC void linphone_player_cbs_set_eof_reached(LinphonePlayerCbs *cbs, LinphonePlayerCbsEofReachedCb cb);
/************ */
/* DEPRECATED */
/* ********** */
/**
 * Get the #LinphonePlayerCbs object associated with the LinphonePlayer.
 * @param player #LinphonePlayer object @notnil
 * @return The #LinphonePlayerCbs object associated with the LinphonePlayer.
 * @deprecated 19/02/2019 use add_callbacks / remove_callbacks instead @notnil
 */
LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphonePlayerCbs * linphone_player_get_callbacks(const LinphonePlayer *player);
/**
 * @}
**/