diff --git a/docs-system/generated/api-model.local.json b/docs-system/generated/api-model.local.json index 7d0b30cbe..58c17e6f7 100644 --- a/docs-system/generated/api-model.local.json +++ b/docs-system/generated/api-model.local.json @@ -7074,7 +7074,7 @@ "name": "filename", "type": "string", "required": true, - "description": "full path to wav file (i.e. \"/SOUNDS/en/system/tada.wav\") Introduced in 2.1.0: If you use a relative path, the current language is appended\nto the path (example: for English language: `/SOUNDS/en` is appended)" + "description": "full path to wav file (i.e. \"/SOUNDS/en/system/tada.wav\") Introduced in 2.1.0: If you use a relative path, the current language is prepended\nto the path (example: for English language: `/SOUNDS/en` is prepended)" }, { "name": "volume", @@ -7098,7 +7098,7 @@ }, "notes": [], "source_location": "radio/src/lua/api_general.cpp", - "raw_luadoc": "@function playFile(filename [, volume])\n\nPlay a file from the SD card\n\n@param filename (string) full path to wav file (i.e. \"/SOUNDS/en/system/tada.wav\")\nIntroduced in 2.1.0: If you use a relative path, the current language is appended\nto the path (example: for English language: `/SOUNDS/en` is appended)\n\n@param volume (number):\n - (1..5) override radio settings Wav volume for the duration of file\n - omitting the parameter uses radio settings Wav volume\n\n@retval none \n\n@status current Introduced in 2.0.0, changed in 2.1.0, changed in 2.10\n\n// targets: BW, COLOR\n//\n// EXAMPLES:\n// playFile(\"armed.wav\", 5) -- play file armed.wav, use Wav volume 2\n// playFile(\"armed.wav\", 1) -- play file armed.wav, use Wav volume 1\n// playFile(\"armed.wav\")\t\t-- play file armed.wav, use radio settings Wav volume", + "raw_luadoc": "@function playFile(filename [, volume])\n\nPlay a file from the SD card\n\n@param filename (string) full path to wav file (i.e. \"/SOUNDS/en/system/tada.wav\")\nIntroduced in 2.1.0: If you use a relative path, the current language is prepended\nto the path (example: for English language: `/SOUNDS/en` is prepended)\n\n@param volume (number):\n - (1..5) override radio settings Wav volume for the duration of file\n - omitting the parameter uses radio settings Wav volume\n\n@retval none \n\n@status current Introduced in 2.0.0, changed in 2.1.0, changed in 2.10\n\n// targets: BW, COLOR\n//\n// EXAMPLES:\n// playFile(\"armed.wav\", 5) -- play file armed.wav, use Wav volume 5\n// playFile(\"armed.wav\", 1) -- play file armed.wav, use Wav volume 1\n// playFile(\"armed.wav\")\t\t-- play file armed.wav, use radio settings Wav volume", "source_line": 1455 }, { diff --git a/docs-system/generated/luals/runtime.d.lua b/docs-system/generated/luals/runtime.d.lua index 4020f70e1..0f16167c9 100644 --- a/docs-system/generated/luals/runtime.d.lua +++ b/docs-system/generated/luals/runtime.d.lua @@ -320,7 +320,7 @@ function playDuration(duration, hourformat) end --- Play a file from the SD card --- @since 2.0.0 ----@param filename string full path to wav file (i.e. "/SOUNDS/en/system/tada.wav") Introduced in 2.1.0: If you use a relative path, the current language is appended to the path (example: for English language: /SOUNDS/en is appended) +---@param filename string full path to wav file (i.e. "/SOUNDS/en/system/tada.wav") Introduced in 2.1.0: If you use a relative path, the current language is prepended to the path (example: for English language: /SOUNDS/en is prepended) ---@param volume? integer - (1..5) override radio settings Wav volume for the duration of file - omitting the parameter uses radio settings Wav volume ---@return unknown none function playFile(filename, volume) end diff --git a/website/md-docs/api-reference/audio-sound/play-file.md b/website/md-docs/api-reference/audio-sound/play-file.md index bfd2771ec..41deb77e8 100644 --- a/website/md-docs/api-reference/audio-sound/play-file.md +++ b/website/md-docs/api-reference/audio-sound/play-file.md @@ -17,7 +17,7 @@ Play a file from the SD card | Name | Req | Type | Description | | --- | --- | --- | --- | -| `filename` | yes | `string` | full path to wav file (i.e. "/SOUNDS/en/system/tada.wav") Introduced in 2.1.0: If you use a relative path, the current language is appended
to the path (example: for English language: `/SOUNDS/en` is appended) | +| `filename` | yes | `string` | full path to wav file (i.e. "/SOUNDS/en/system/tada.wav") Introduced in 2.1.0: If you use a relative path, the current language is prepended
to the path (example: for English language: `/SOUNDS/en` is prepended) | | `volume` | no | `integer` | | ## Returns diff --git a/website/md-docs/api-reference/review-runtime-play-file.md b/website/md-docs/api-reference/review-runtime-play-file.md index 71df41206..36fd21344 100644 --- a/website/md-docs/api-reference/review-runtime-play-file.md +++ b/website/md-docs/api-reference/review-runtime-play-file.md @@ -32,15 +32,15 @@ edit docs-system/overlays/.md, then rebuild. - +
FieldKindCurrent TypeDescriptionSelect Type
filenameparamstringfull path to wav file (i.e. "/SOUNDS/en/system/tada.wav") Introduced in 2.1.0: If you use a relative path, the current language is appended -to the path (example: for English language: `/SOUNDS/en` is appended)
filenameparamstringfull path to wav file (i.e. "/SOUNDS/en/system/tada.wav") Introduced in 2.1.0: If you use a relative path, the current language is prepended +to the path (example: for English language: `/SOUNDS/en` is prepended)
volumeparaminteger- (1..5) override radio settings Wav volume for the duration of file - omitting the parameter uses radio settings Wav volume
nonereturnunknown
- +
@@ -53,8 +53,8 @@ to the path (example: for English language: `/SOUNDS/en` is appended)