この文書の現在のバージョンと選択したバージョンの差分を表示します。
両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン | ||
vci:script:reference:exportassets:audio [2023/07/28 13:36] Ramen APIリファレンスへリンク修正 |
vci:script:reference:exportassets:audio [2023/10/04 15:19] pastatto 非推奨の表記追加 |
||
---|---|---|---|
ライン 4: | ライン 4: | ||
このページは過去の情報となります。\\ | このページは過去の情報となります。\\ | ||
- | 新しいスクリプトリファレンスは**[[https://developer.virtualcast.jp/vci-docs/api/|こちら]]**になります。 | + | 新しいスクリプトリファレンスは**[[https://developer.virtualcast.jp/vci-docs/api/classes/ExportAudio/index.html|こちら]]**になります。 |
</WRAP> | </WRAP> | ||
VCIの中全体のオーディオを制御できます。\\ | VCIの中全体のオーディオを制御できます。\\ | ||
- | ただし全体を対象とするので、オーディオの名前被りやインデックスが分からないといった場合があります。\\ | + | また''_ALL_''が付いている関数は空間内に居るユーザー全員のVCIで実行されます。 |
- | そのような場合は[[https://developer.virtualcast.jp/vci-docs/api/classes/ExportAudioSource/index.html|ExportAudioSource]]の使用を推奨します。\\ | + | |
- | また''_ALL_''が付いている関数はスタジオ内に居るユーザー全員のVCIで実行されます。\\ | + | ExportAudioはVCI内に含まれるオブジェクト全体を参照してしまうので、オーディオの名前被りやインデックスが分からないといった場合があります。\\ |
+ | 現在はExportAudioは非推奨で、**[[https://developer.virtualcast.jp/vci-docs/api/classes/ExportAudioSource/index.html|ExportAudioSource]]の使用が推奨**となりました。\\ | ||
^ExportAssets^^^ | ^ExportAssets^^^ | ||
ライン 101: | ライン 103: | ||
* 引数は全て入れる必要があります。省略できません。 | * 引数は全て入れる必要があります。省略できません。 | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
* 音量は0から1の間で指定し、1を超えた値で指定された場合は1として使います。 | * 音量は0から1の間で指定し、1を超えた値で指定された場合は1として使います。 | ||
ライン 160: | ライン 162: | ||
**第1引数:インデックス番号(number) 第2引数:音量(number)** | **第1引数:インデックス番号(number) 第2引数:音量(number)** | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
* 音量は0から1の間で指定し、1を超えた値で指定された場合は1として使います。 | * 音量は0から1の間で指定し、1を超えた値で指定された場合は1として使います。 | ||
ライン 212: | ライン 214: | ||
**第1引数:インデックス番号(number)** | **第1引数:インデックス番号(number)** | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
サンプル\\ | サンプル\\ | ||
ライン 272: | ライン 274: | ||
**第1引数:インデックス番号(number) 第2引数:停止/再生の設定(bool)** | **第1引数:インデックス番号(number) 第2引数:停止/再生の設定(bool)** | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
* trueの場合、オーディオの再生を一時停止します。\\ falseの場合、一時停止しているオーディオの再生を再開します。 | * trueの場合、オーディオの再生を一時停止します。\\ falseの場合、一時停止しているオーディオの再生を再開します。 | ||
ライン 361: | ライン 363: | ||
**インデックス番号(number)** | **インデックス番号(number)** | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
**返り値** | **返り値** | ||
* 指定した音声の再生状況をbool型で返します。 | * 指定した音声の再生状況をbool型で返します。 | ||
ライン 444: | ライン 446: | ||
**インデックス番号(number)** | **インデックス番号(number)** | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
**返り値** | **返り値** | ||
* 指定した音声ファイルの長さをnumber型で返します。 | * 指定した音声ファイルの長さをnumber型で返します。 | ||
ライン 518: | ライン 520: | ||
**インデックス番号(number)** | **インデックス番号(number)** | ||
- | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[https://virtualcast.jp/wiki/doku.php?id=vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 | + | * オーディオはAudioIndexのnumberで指定します。\\ Indexの割り当てルールは[[vci:script:reference:exportassets:audio#audioindex | こちら]]を確認してください。 |
**返り値** | **返り値** | ||
* 指定した音声ファイルの現在の再生位置を返します。 | * 指定した音声ファイルの現在の再生位置を返します。 |