vuepress-theme-plume/assets/audioReader-DarkruNN.js

import{$ as e,B as t,P as n,_ as r,f as i,g as a,h as o,l as s}from"./runtime-core.esm-bundler-TY2dTQsQ.js";import{t as c}from"./plugin-vue_export-helper-PrwMxFSs.js";var l=JSON.parse(`{"path":"/en/guide/embed/audio/reader/","title":"Audio Reader | Guide","lang":"en-US","frontmatter":{"title":"Audio Reader","icon":"rivet-icons:audio","createTime":"2025/10/08 22:31:01","permalink":"/en/guide/embed/audio/reader/","description":"Overview The theme supports embedding audio reading capabilities in documentation. This feature is powered by . Audio Reader is not a music player; it simply embeds an () button...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Audio Reader\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-10-09T07:46:05.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/guide/embed/audio/reader/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"Audio Reader"}],["meta",{"property":"og:description","content":"Overview The theme supports embedding audio reading capabilities in documentation. This feature is powered by . Audio Reader is not a music player; it simply embeds an () button..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-10-09T07:46:05.000Z"}],["meta",{"property":"article:modified_time","content":"2025-10-09T07:46:05.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/guide/embed/audio/reader/"}]]},"readingTime":{"minutes":1.26,"words":378},"git":{"createdTime":1759995965000,"updatedTime":1759995965000,"contributors":[{"name":"pengzhanbo","username":"pengzhanbo","email":"volodymyr@foxmail.com","commits":1,"avatar":"https://avatars.githubusercontent.com/pengzhanbo?v=4","url":"https://github.com/pengzhanbo"}],"changelog":[{"hash":"385059f214cb07fc9a098859e889432fb81f998b","time":1759995965000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update en docs (#708)"}]},"autoDesc":true,"filePathRelative":"en/guide/embed/audioReader.md","headers":[],"bulletin":false}`),u={name:`audioReader.md`},d={class:`code-block-title`,"data-title":`.vuepress/config.ts`},f={class:`code-block-title-bar`},p={class:`title`};function m(c,l,u,m,h,g){let _=t(`VPLink`),v=t(`AudioReader`,!0),y=t(`VPIcon`);return n(),i(`div`,null,[l[12]||=s(`h2`,{id:`overview`,tabindex:`-1`},[s(`a`,{class:`header-anchor`,href:`#overview`},[s(`span`,null,`Overview`)])],-1),l[13]||=s(`p`,null,`The theme supports embedding audio reading capabilities in documentation.`,-1),s(`p`,null,[l[1]||=a(`This feature is powered by `,-1),r(_,{href:`../../config/plugins/markdown-power.md`},{default:e(()=>[...l[0]||=[a(`vuepress-plugin-md-power`,-1)]]),_:1}),l[2]||=a(`.`,-1)]),s(`p`,null,[l[3]||=s(`strong`,null,`Audio Reader`,-1),l[4]||=a(` is not a music player; it simply embeds an (`,-1),r(v,{src:`https://sensearch.baidu.com/gettts?lan=en&spd=3&source=alading&text=audio`}),l[5]||=a(`) button within content that plays an audio clip when clicked.`,-1)]),l[14]||=s(`p`,null,[a(`It is suitable for playing short audio clips, such as `),s(`strong`,null,`word pronunciation guides`),a(`.`)],-1),l[15]||=s(`h2`,{id:`configuration`,tabindex:`-1`},[s(`a`,{class:`header-anchor`,href:`#configuration`},[s(`span`,null,`Configuration`)])],-1),l[16]||=s(`p`,null,`This feature is disabled by default. You need to enable it in the theme configuration.`,-1),s(`div`,d,[s(`div`,f,[s(`span`,p,[r(y,{provider:`iconify`,name:`vscode-icons:file-type-typescript`}),l[6]||=a(`.vuepress/config.ts`,-1)])]),l[7]||=o(`<div class="language-ts" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark has-diff vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">  theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;">plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">    markdown</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line diff add"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">      audioReader</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">true</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">, </span></span>
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">    },</span></span>
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">  })</span></span>
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre></div>`,1)]),l[17]||=o(`<h2 id="markdown-syntax" tabindex="-1"><a class="header-anchor" href="#markdown-syntax"><span>Markdown Syntax</span></a></h2><p>The audio embedding markdown syntax is an inline syntax, allowing usage anywhere within markdown.</p><div class="language-md" data-highlighter="shiki" data-ext="md" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-md"><span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">@</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">audioReader</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">](</span><span style="--shiki-light:#393A3490;--shiki-light-text-decoration:underline;--shiki-dark:#DEDCD590;--shiki-dark-text-decoration:underline;">src</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)</span></span></code></pre></div><p>With configuration options:</p><div class="language-md" data-highlighter="shiki" data-ext="md" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-md"><span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">@</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">audioReader type=&quot;audio/mpeg&quot; title=&quot;title&quot; autoplay start-time=&quot;0&quot; end-time=&quot;10&quot; volume=&quot;0.7&quot;</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">](</span><span style="--shiki-light:#393A3490;--shiki-light-text-decoration:underline;--shiki-dark:#DEDCD590;--shiki-dark-text-decoration:underline;">src</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)</span></span></code></pre></div><p><strong>Parameter Description:</strong></p><ul><li><code>type</code>: Audio type, formatted as <code>audio/mpeg</code>. Defaults to inference from the file extension in the audio URL. If the URL lacks an extension, declare manually.</li><li><code>title</code>: Audio title, displayed before the audio icon.</li><li><code>autoplay</code>: Whether to enable autoplay (not recommended).</li><li><code>start-time</code>: Audio playback start time in seconds.</li><li><code>end-time</code>: Audio playback end time in seconds.</li><li><code>volume</code>: Audio playback volume, range from <code>0 ~ 1</code>.</li></ul><h2 id="global-component" tabindex="-1"><a class="header-anchor" href="#global-component"><span>Global Component</span></a></h2><p>The theme provides a global component <code>&lt;AudioReader /&gt;</code> to support more flexible and comprehensive usage.</p><h3 id="props" tabindex="-1"><a class="header-anchor" href="#props"><span>Props</span></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>src</td><td><code>string</code></td><td>Required, audio source URL</td></tr><tr><td>type</td><td><code>string</code></td><td>Optional, audio format, parsed from <code>src</code> by default</td></tr><tr><td>autoplay</td><td><code>boolean</code></td><td>Optional, whether to enable autoplay (not recommended)</td></tr><tr><td>startTime</td><td><code>number</code></td><td>Optional, audio playback start time in seconds</td></tr><tr><td>endTime</td><td><code>number</code></td><td>Optional, audio playback end time in seconds</td></tr><tr><td>volume</td><td><code>number</code></td><td>Optional, audio playback volume, range from <code>0 ~ 1</code></td></tr></tbody></table><h2 id="examples" tabindex="-1"><a class="header-anchor" href="#examples"><span>Examples</span></a></h2><p><strong>Input:</strong></p><div class="language-md" data-highlighter="shiki" data-ext="md" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-md"><span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">audio 美 </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">ˈɔːdioʊ</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> @</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">audioReader</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">](</span><span style="--shiki-light:#393A3490;--shiki-light-text-decoration:underline;--shiki-dark:#DEDCD590;--shiki-dark-text-decoration:underline;">/audio/audio.mp3</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)</span></span></code></pre></div><p><strong>Output:</strong></p>`,15),s(`p`,null,[l[8]||=a(`audio 美 [ˈɔːdioʊ] `,-1),r(v,{src:`https://sensearch.baidu.com/gettts?lan=en&spd=3&source=alading&text=audio`})]),l[18]||=o(`<p><strong>Input:</strong></p><div class="language-md" data-highlighter="shiki" data-ext="md" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-md"><span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">audio 美 @</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">audioReader title=&quot;[ˈɔːdioʊ]&quot;</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">](</span><span style="--shiki-light:#393A3490;--shiki-light-text-decoration:underline;--shiki-dark:#DEDCD590;--shiki-dark-text-decoration:underline;">/audio/audio.mp3</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)</span></span></code></pre></div><p><strong>Output:</strong></p>`,3),s(`p`,null,[l[9]||=a(`audio 美 `,-1),r(v,{src:`https://sensearch.baidu.com/gettts?lan=en&spd=3&source=alading&text=audio`,title:[c.ˈɔːdioʊ]},null,8,[`title`])]),l[19]||=o(`<p><strong>Input:</strong></p><div class="language-md" data-highlighter="shiki" data-ext="md" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-md"><span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">audio 美 </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">&lt;</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">AudioReader</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> src</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">=</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">&quot;</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/audio/audio.mp3</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">&quot;</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">&gt;[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">ˈɔːdioʊ</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]&lt;/</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">AudioReader</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">&gt;</span></span></code></pre></div><p><strong>Output:</strong></p>`,3),s(`p`,null,[l[11]||=a(`audio 美 `,-1),r(v,{src:`https://sensearch.baidu.com/gettts?lan=en&spd=3&source=alading&text=audio`},{default:e(()=>[...l[10]||=[a(`[ˈɔːdioʊ]`,-1)]]),_:1})])])}var h=c(u,[[`render`,m]]);export{l as _pageData,h as default};