obs-studio/libobs/obs-service.h
jp9000 0b4a259e56 Remove 'locale' parameter from all callbacks
The locale parameter was a mistake, because it puts extra needless
burden upon the module developer to have to handle this variable for
each and every single callback function.  The parameter is being removed
in favor of a single centralized module callback function that
specifically updates locale information for a module only when needed.
2014-06-25 12:36:26 -07:00

63 lines
2 KiB
C

/******************************************************************************
Copyright (C) 2013-2014 by Hugh Bailey <obs.jim@gmail.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
#pragma once
struct obs_service_info {
/* required */
const char *id;
const char *(*getname)(void);
void *(*create)(obs_data_t settings, obs_service_t service);
void (*destroy)(void *data);
/* optional */
void (*activate)(void *data, obs_data_t settings);
void (*deactivate)(void *data);
void (*update)(void *data, obs_data_t settings);
void (*defaults)(obs_data_t settings);
obs_properties_t (*properties)(void);
/**
* Called when getting ready to start up an output, before the encoders
* and output are initialized
*
* @param data Internal service data
* @param output Output context
* @eturn true to allow the output to start up,
* false to prevent output from starting up
*/
bool (*initialize)(void *data, obs_output_t output);
const char *(*get_url)(void *data);
const char *(*get_key)(void *data);
const char *(*get_username)(void *data);
const char *(*get_password)(void *data);
/* TODO: more stuff later */
};
EXPORT void obs_register_service_s(const struct obs_service_info *info,
size_t size);
#define obs_register_service(info) \
obs_register_service_s(info, sizeof(struct obs_service_info))