docs/sphinx: Fix various typos
(This modifies UI, libobs, deps/obs-scripting, various cmake files) Found using: `codespell -q 3 -S *.ini,./UI/data/locale,./deps/w32-pthreads -L aci,dur,iff,mut,numer,uint`
This commit is contained in:
luz.paz
jp9000
@@ -98,7 +98,7 @@ save/load individual sources manually by using
|
||||
:c:func:`obs_save_source()` and :c:func:`obs_load_source()`.
|
||||
|
||||
*(Author's note: I should not have written those helper functions; the
|
||||
downside is I had to add "private" sources that aren't savable via the*
|
||||
downside is I had to add "private" sources that aren't saveable via the*
|
||||
:c:func:`obs_source_create_private()` *function. Just one of the many
|
||||
minor design flaws that can occur during long-term development.)*
|
||||
|
||||
|
||||
@@ -826,7 +826,7 @@ Draw Functions
|
||||
|
||||
Gets the current viewport
|
||||
|
||||
:param rect: Pointer to recieve viewport rectangle
|
||||
:param rect: Pointer to receive viewport rectangle
|
||||
|
||||
---------------------
|
||||
|
||||
|
||||
@@ -249,5 +249,5 @@
|
||||
|
||||
Normalizes a vector
|
||||
|
||||
:param dst: Desination
|
||||
:param dst: Destination
|
||||
:param v: Vector to normalize
|
||||
|
||||
@@ -273,7 +273,7 @@
|
||||
|
||||
Normalizes a vector
|
||||
|
||||
:param dst: Desination
|
||||
:param dst: Destination
|
||||
:param v: Vector to normalize
|
||||
|
||||
---------------------
|
||||
|
||||
@@ -268,7 +268,7 @@
|
||||
|
||||
Normalizes a vector
|
||||
|
||||
:param dst: Desination
|
||||
:param dst: Destination
|
||||
:param v: Vector to normalize
|
||||
|
||||
---------------------
|
||||
|
||||
@@ -95,7 +95,7 @@ dynamic array value with a reference (&) operator. For example:
|
||||
|
||||
.. function:: void da_copy(da_dst, da_src)
|
||||
|
||||
Makes a copy of a dyanmic array.
|
||||
Makes a copy of a dynamic array.
|
||||
|
||||
:param da_dst: The dynamic array to copy to
|
||||
:param da_src: The dynamic array to copy from
|
||||
|
||||
@@ -188,7 +188,7 @@ Dynamic String Functions
|
||||
Copies a specific number of characters from another dynamic string.
|
||||
|
||||
:param dst: Dynamic string
|
||||
:param src: Dynamic tring to copy
|
||||
:param src: Dynamic string to copy
|
||||
:param len: Number of characters to copy
|
||||
|
||||
----------------------
|
||||
@@ -234,7 +234,7 @@ Dynamic String Functions
|
||||
|
||||
.. function:: void dstr_cat_dstr(struct dstr *dst, const struct dstr *str)
|
||||
|
||||
Concatenates a dyanmic string with another dynamic string.
|
||||
Concatenates a dynamic string with another dynamic string.
|
||||
|
||||
:param dst: Dynamic string to concatenate to
|
||||
:param str: Dynamic string to concatenate with
|
||||
@@ -308,7 +308,7 @@ Dynamic String Functions
|
||||
Removes a specific number of characters starting from a specific
|
||||
index.
|
||||
|
||||
:param dst: Dyanmic string
|
||||
:param dst: Dynamic string
|
||||
:param idx: Index to start removing characters at
|
||||
:param count: Number of characters to remove
|
||||
|
||||
|
||||
@@ -355,7 +355,7 @@ Other Path/File Functions
|
||||
|
||||
.. function:: int os_copyfile(const char *file_in, const char *file_out)
|
||||
|
||||
Copys a file.
|
||||
Copies a file.
|
||||
|
||||
---------------------
|
||||
|
||||
|
||||
@@ -159,7 +159,7 @@ Profiler Data Access Functions
|
||||
|
||||
:param snap: A profiler snapshot
|
||||
:param filename: The path to the CSV file to save
|
||||
:return: *true* if successfuly written, *false* otherwise
|
||||
:return: *true* if successfully written, *false* otherwise
|
||||
|
||||
----------------------
|
||||
|
||||
@@ -169,7 +169,7 @@ Profiler Data Access Functions
|
||||
|
||||
:param snap: A profiler snapshot
|
||||
:param filename: The path to the gzipped CSV file to save
|
||||
:return: *true* if successfuly written, *false* otherwise
|
||||
:return: *true* if successfully written, *false* otherwise
|
||||
|
||||
----------------------
|
||||
|
||||
|
||||
@@ -73,7 +73,7 @@ Event Functions
|
||||
|
||||
- 0 - successful
|
||||
- ETIMEDOUT - Timed out
|
||||
- EINVAL - An unexpected error occured
|
||||
- EINVAL - An unexpected error occurred
|
||||
|
||||
----------------------
|
||||
|
||||
@@ -86,7 +86,7 @@ Event Functions
|
||||
|
||||
- 0 - successful
|
||||
- EAGAIN - The event is not signaled
|
||||
- EINVAL - An unexpected error occured
|
||||
- EINVAL - An unexpected error occurred
|
||||
|
||||
----------------------
|
||||
|
||||
@@ -123,7 +123,7 @@ Semaphore Functions
|
||||
|
||||
.. function:: void os_sem_destroy(os_sem_t *sem)
|
||||
|
||||
Destroys a sempahore object.
|
||||
Destroys a semaphore object.
|
||||
|
||||
:param sem: Semaphore object
|
||||
|
||||
@@ -140,7 +140,7 @@ Semaphore Functions
|
||||
|
||||
.. function:: int os_sem_wait(os_sem_t *sem)
|
||||
|
||||
Decrements the semphore or waits until the semaphore has been
|
||||
Decrements the semaphore or waits until the semaphore has been
|
||||
incremented.
|
||||
|
||||
:param sem: Semaphore object
|
||||
|
||||
@@ -98,7 +98,7 @@ to communicate with libobs and front-ends.
|
||||
Module Externs
|
||||
--------------
|
||||
|
||||
These functions are externs that are useable throughout the module.
|
||||
These functions are externs that are usable throughout the module.
|
||||
|
||||
.. function:: const char *obs_module_text(const char *lookup_string)
|
||||
|
||||
|
||||
@@ -122,7 +122,7 @@ Output Definition Structure (obs_output_info)
|
||||
|
||||
.. member:: void (*obs_output_info.raw_audio)(void *data, struct audio_data *frames)
|
||||
|
||||
This is called when the output recieves raw audio data. Only applies
|
||||
This is called when the output receives raw audio data. Only applies
|
||||
to outputs that are not encoded.
|
||||
|
||||
**This callback must be used with single-track raw outputs.**
|
||||
@@ -131,7 +131,7 @@ Output Definition Structure (obs_output_info)
|
||||
|
||||
.. member:: void (*obs_output_info.raw_audio2)(void *data, size_t idx, struct audio_data *frames)
|
||||
|
||||
This is called when the output recieves raw audio data. Only applies
|
||||
This is called when the output receives raw audio data. Only applies
|
||||
to outputs that are not encoded.
|
||||
|
||||
**This callback must be used with multi-track raw outputs.**
|
||||
@@ -251,7 +251,7 @@ Output Signals
|
||||
|
||||
:Parameters: - **code** - Can be one of the following values:
|
||||
|
||||
| OBS_OUTPUT_SUCCESS - Successfuly stopped
|
||||
| OBS_OUTPUT_SUCCESS - Successfully stopped
|
||||
| OBS_OUTPUT_BAD_PATH - The specified path was invalid
|
||||
| OBS_OUTPUT_CONNECT_FAILED - Failed to connect to a server
|
||||
| OBS_OUTPUT_INVALID_STREAM - Invalid stream path
|
||||
@@ -368,7 +368,7 @@ General Output Functions
|
||||
|
||||
Starts the output.
|
||||
|
||||
:return: *true* if output successfuly started, *false* otherwise. If
|
||||
:return: *true* if output successfully started, *false* otherwise. If
|
||||
the output failed to start,
|
||||
:c:func:`obs_output_get_last_error()` may contain a specific
|
||||
error string related to the reason
|
||||
@@ -460,7 +460,7 @@ General Output Functions
|
||||
|
||||
Pause an output (if supported by the output).
|
||||
|
||||
:return: *true* if the output was paused successfuly, *false*
|
||||
:return: *true* if the output was paused successfully, *false*
|
||||
otherwise
|
||||
|
||||
---------------------
|
||||
@@ -818,7 +818,7 @@ Functions used by outputs
|
||||
to the user
|
||||
|
||||
:param code: | Can be one of the following values:
|
||||
| OBS_OUTPUT_SUCCESS - Successfuly stopped
|
||||
| OBS_OUTPUT_SUCCESS - Successfully stopped
|
||||
| OBS_OUTPUT_BAD_PATH - The specified path was invalid
|
||||
| OBS_OUTPUT_CONNECT_FAILED - Failed to connect to a server
|
||||
| OBS_OUTPUT_INVALID_STREAM - Invalid stream path
|
||||
|
||||
@@ -182,7 +182,7 @@ Property Object Functions
|
||||
|
||||
- **OBS_COMBO_TYPE_EDITABLE** - Can be edited.
|
||||
Only used with string lists.
|
||||
- **OBS_COMBO_TYPE_LIST** - Not ediable.
|
||||
- **OBS_COMBO_TYPE_LIST** - Not editable.
|
||||
|
||||
:param format: Can be one of the following values:
|
||||
|
||||
|
||||
@@ -398,7 +398,7 @@ Scene Item Functions
|
||||
|
||||
.. function:: void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item, struct matrix4 *transform)
|
||||
|
||||
Gets the transform matrix of the scene item used for the bouding box
|
||||
Gets the transform matrix of the scene item used for the bounding box
|
||||
or edges of the scene item.
|
||||
|
||||
---------------------
|
||||
|
||||
@@ -96,7 +96,7 @@ Source Definition Structure (obs_source_info)
|
||||
user.
|
||||
|
||||
When this is used, the source will receive interaction events if
|
||||
theese callbacks are provided:
|
||||
these callbacks are provided:
|
||||
:c:member:`obs_source_info.mouse_click`,
|
||||
:c:member:`obs_source_info.mouse_move`,
|
||||
:c:member:`obs_source_info.mouse_wheel`,
|
||||
@@ -286,7 +286,7 @@ Source Definition Structure (obs_source_info)
|
||||
|
||||
Called to enumerate all active sources being used within this
|
||||
source. If the source has children that render audio/video it must
|
||||
implement this callback. Only used with sources that have tha
|
||||
implement this callback. Only used with sources that have the
|
||||
OBS_SOURCE_COMPOSITE output capability flag.
|
||||
|
||||
:param enum_callback: Enumeration callback
|
||||
@@ -391,14 +391,14 @@ Source Definition Structure (obs_source_info)
|
||||
.. member:: bool (*obs_source_info.audio_render)(void *data, uint64_t *ts_out, struct obs_source_audio_mix *audio_output, uint32_t mixers, size_t channels, size_t sample_rate)
|
||||
|
||||
Called to render audio of composite sources. Only used with sources
|
||||
that have tha OBS_SOURCE_COMPOSITE output capability flag.
|
||||
that have the OBS_SOURCE_COMPOSITE output capability flag.
|
||||
|
||||
.. member:: void (*obs_source_info.enum_all_sources)(void *data, obs_source_enum_proc_t enum_callback, void *param)
|
||||
|
||||
Called to enumerate all active and inactive sources being used
|
||||
within this source. If this callback isn't implemented,
|
||||
enum_active_sources will be called instead. Only used with sources
|
||||
that have tha OBS_SOURCE_COMPOSITE output capability flag.
|
||||
that have the OBS_SOURCE_COMPOSITE output capability flag.
|
||||
|
||||
This is typically used if a source can have inactive child sources.
|
||||
|
||||
@@ -836,7 +836,7 @@ General Source Functions
|
||||
.. function:: bool obs_source_active(const obs_source_t *source)
|
||||
|
||||
:return: *true* if active, *false* if not. A source is only
|
||||
consdiered active if it's being shown on the final mix
|
||||
considered active if it's being shown on the final mix
|
||||
|
||||
---------------------
|
||||
|
||||
@@ -1268,8 +1268,8 @@ Transitions
|
||||
Sets/gets the scale type for sources within the transition.
|
||||
|
||||
:param type: | OBS_TRANSITION_SCALE_MAX_ONLY - Scale to aspect ratio, but only to the maximum size of each source
|
||||
| OBS_TRANSITION_SCALE_ASPECT - Alwasy scale the sources, but keep aspect ratio
|
||||
| OBS_TRANSITION_SCALE_STRETCH - Scale and stretch the sources to the size of the transision
|
||||
| OBS_TRANSITION_SCALE_ASPECT - Always scale the sources, but keep aspect ratio
|
||||
| OBS_TRANSITION_SCALE_STRETCH - Scale and stretch the sources to the size of the transition
|
||||
|
||||
---------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user