en-US/AudioWorks.Commands.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-AudioMetadata</command:name> <command:verb>Clear</command:verb> <command:noun>AudioMetadata</command:noun> <maml:description> <maml:para>Clears one or more metadata fields on an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-AudioMetadata cmdlet clears one or more metadata fields. These changes are not persisted to disk unless followed by a call to Save-AudioMetadata. If no metadata fields are specified, all fields are cleared.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-AudioMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Clears the title.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Artist</maml:name> <maml:Description> <maml:para>Clears the artist.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Album</maml:name> <maml:Description> <maml:para>Clears the album.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlbumArtist</maml:name> <maml:Description> <maml:para>Clears the album artist.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Composer</maml:name> <maml:Description> <maml:para>Clears the composer.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Genre</maml:name> <maml:Description> <maml:para>Clears the genre.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:Description> <maml:para>Clears the comment.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Day</maml:name> <maml:Description> <maml:para>Clears the day of the month.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Month</maml:name> <maml:Description> <maml:para>Clears the month.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Year</maml:name> <maml:Description> <maml:para>Clears the year.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackNumber</maml:name> <maml:Description> <maml:para>Clears the track number.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackCount</maml:name> <maml:Description> <maml:para>Clears the track count.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Loudness</maml:name> <maml:Description> <maml:para>Clears the track peak, album peak, track gain and album gain.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CoverArt</maml:name> <maml:Description> <maml:para>Clears the cover art.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Clears the title.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Artist</maml:name> <maml:Description> <maml:para>Clears the artist.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Album</maml:name> <maml:Description> <maml:para>Clears the album.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlbumArtist</maml:name> <maml:Description> <maml:para>Clears the album artist.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Composer</maml:name> <maml:Description> <maml:para>Clears the composer.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Genre</maml:name> <maml:Description> <maml:para>Clears the genre.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:Description> <maml:para>Clears the comment.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Day</maml:name> <maml:Description> <maml:para>Clears the day of the month.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Month</maml:name> <maml:Description> <maml:para>Clears the month.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Year</maml:name> <maml:Description> <maml:para>Clears the year.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackNumber</maml:name> <maml:Description> <maml:para>Clears the track number.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackCount</maml:name> <maml:Description> <maml:para>Clears the track count.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Loudness</maml:name> <maml:Description> <maml:para>Clears the track peak, album peak, track gain and album gain.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CoverArt</maml:name> <maml:Description> <maml:para>Clears the cover art.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Remove all metadata from an existing file -----</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Clear-AudioMetadata -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Clears all metadata fields from test.flac, then saves the changes to disk.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 2: Remove a metadata field from an existing file ---</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Clear-AudioMetadata -Loudness -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Clears loudness (REPLAYGAIN_*) fields from test.flac, then saves the changes to disk.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 3: Export to a new file, with no metadata preserved -</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Clear-AudioMetadata -PassThru | Export-AudioFile LameMP3 .</dev:code> <dev:remarks> <maml:para>Exports test.flac as test.mp3 (in the current directory), without any metadata (no ID3 tag will be written).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Clear-AudioMetadata.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-AudioCoverArt</command:name> <command:verb>Export</command:verb> <command:noun>AudioCoverArt</command:noun> <maml:description> <maml:para>Exports cover art from an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Export-AudioCoverArt cmdlet extracts the cover art from an audio file, and saves it to disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-AudioCoverArt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the output directory path.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify an Artist then Album heirarchy relative to the current directory, you would use "{Artist}\{Album}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the source audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the output file name.</maml:para> <maml:para>The file extension will be selected automatically and should not be included. If this parameter is omitted, the name will be the same as the source audio file.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify a name consisting of the track number, a hyphen, then the title, you would use "{TrackNumber} - {Title}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that existing files should be overwritten.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the output directory path.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify an Artist then Album heirarchy relative to the current directory, you would use "{Artist}\{Album}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the source audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the output file name.</maml:para> <maml:para>The file extension will be selected automatically and should not be included. If this parameter is omitted, the name will be the same as the source audio file.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify a name consisting of the track number, a hyphen, then the title, you would use "{TrackNumber} - {Title}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that existing files should be overwritten.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the source audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Extract cover art from an audio file to an image file</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Export-AudioCoverArt .</dev:code> <dev:remarks> <maml:para>Extracts the cover art stored in test.flac as test.png or test.jpg, in the current directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Extract cover art from all audio files in the current directory, laid out according to each audio file's metadata</maml:title> <dev:code>PS C:\> Get-AudioFile *.flac | Export-AudioCoverArt "{Artist}\{Album}" -Name "{Artist} - {Album}"</dev:code> <dev:remarks> <maml:para>Extracts the cover art stored in each .flac file, saving the result under an artist then album directory structure, with a file name composed of the artist and album title.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Export-AudioCoverArt.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-AudioFile</command:name> <command:verb>Export</command:verb> <command:noun>AudioFile</command:noun> <maml:description> <maml:para>Exports an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Export-AudioFile cmdlet creates a new audio file using the specified encoder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-AudioFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Encoder</maml:name> <maml:Description> <maml:para>Specifies the encoder to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the output directory path.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify an Artist then Album heirarchy relative to the current directory, you would use "{Artist}\{Album}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the source audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the output file name.</maml:para> <maml:para>The file extension will be selected automatically and should not be included. If this parameter is omitted, the name will be the same as the source audio file.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify a name consisting of the track number, a hyphen, then the title, you would use "{TrackNumber} - {Title}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that existing files should be overwritten.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxDegreeOfParallelism</maml:name> <maml:Description> <maml:para>Sets the maximum degree of parallelism.</maml:para> <maml:para>Defaults to the logical processor count.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Encoder</maml:name> <maml:Description> <maml:para>Specifies the encoder to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the output directory path.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify an Artist then Album heirarchy relative to the current directory, you would use "{Artist}\{Album}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the source audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the output file name.</maml:para> <maml:para>The file extension will be selected automatically and should not be included. If this parameter is omitted, the name will be the same as the source audio file.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify a name consisting of the track number, a hyphen, then the title, you would use "{TrackNumber} - {Title}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that existing files should be overwritten.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxDegreeOfParallelism</maml:name> <maml:Description> <maml:para>Sets the maximum degree of parallelism.</maml:para> <maml:para>Defaults to the logical processor count.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the source audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Export an audio file to a new audio format in the same directory</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Export-AudioFile LameMP3 .</dev:code> <dev:remarks> <maml:para>Exports test.flac as test.mp3 using default settings, in the current directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 2: Re-encode an audio file in-place ---------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Export-AudioFile FLAC . -Force</dev:code> <dev:remarks> <maml:para>Re-encodes test.flac in-place, using default settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Export all audio files in the current directory, laid out according to each audio file's metadata</maml:title> <dev:code>PS C:\> Get-AudioFile *.flac | Export-AudioFile LameMP3 "{Artist}\{Album}" -Name "{TrackNumber} - {Title}"</dev:code> <dev:remarks> <maml:para>Exports all .flac files in the current directory, under an artist then album directory structure, with a file name composed of the track number and title.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Export-AudioFile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioAnalyzerInfo</command:name> <command:verb>Get</command:verb> <command:noun>AudioAnalyzerInfo</command:noun> <maml:description> <maml:para>Gets information about the available audio analyzers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioAnalyzerInfo cmdlet gets objects that describe the audio analyzers currently loaded and available for use with the Measure-AudioFile cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioAnalyzerInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Api.AudioAnalyzerInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AudioAnalyzerInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioAnalyzerInfo.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioCoverArt</command:name> <command:verb>Get</command:verb> <command:noun>AudioCoverArt</command:noun> <maml:description> <maml:para>Gets an object that represents an audio file or album's cover art.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioCoverArt cmdlet gets objects that represent cover art. Cover art can be applied to and extracted from audio files when supported by the audio format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioCoverArt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcards are permitted. This parameter is required, but the parameter name ("Path") is optional.</maml:para> <maml:para>Use a dot (.) to specify the current location. Use the wildcard character (*) to specify all the items in the current location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AudioCoverArt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:Description> <maml:para>Specifies a path to the item. Unlike the Path parameter, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AudioCoverArt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>FileInfo</maml:name> <maml:Description> <maml:para>Specifies the file information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcards are permitted. This parameter is required, but the parameter name ("Path") is optional.</maml:para> <maml:para>Use a dot (.) to specify the current location. Use the wildcard character (*) to specify all the items in the current location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:Description> <maml:para>Specifies a path to the item. Unlike the Path parameter, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>FileInfo</maml:name> <maml:Description> <maml:para>Specifies the file information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcards are permitted. This parameter is required, but the parameter name ("Path") is optional.</maml:para> <maml:para>Use a dot (.) to specify the current location. Use the wildcard character (*) to specify all the items in the current location.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>Specifies the file information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ICoverArt</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------- Example 1: Retrieve cover art from an image file -------</maml:title> <dev:code>PS C:\> $cover = Get-AudioCoverArt Folder.png</dev:code> <dev:remarks> <maml:para>Gets a cover art object from a file named Folder.png, located in the current directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Retrieve cover art from an image file, then apply it to an audio file as metadata</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Set-AudioMetadata -CoverArt (Get-AudioCoverArt Folder.png) -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Sets the cover art in test.flac to the image retrieved from Folder.png, then saves the changes to disk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioCoverArt.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioEncoderInfo</command:name> <command:verb>Get</command:verb> <command:noun>AudioEncoderInfo</command:noun> <maml:description> <maml:para>Gets information about the available audio encoders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioEncoderInfo cmdlet gets objects that describe the audio encoders currently loaded and available for use with the Export-AudioFile cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioEncoderInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Api.AudioEncoderInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AudioEncoderInfo Name Description ---- ----------- AppleAAC Apple MPEG-4 Advanced Audio Codec ALAC Apple Lossless Audio Codec FLAC Free Lossless Audio Codec LameMP3 Lame MPEG Audio Layer 3 Vorbis Ogg Vorbis Wave Waveform Audio File Format</dev:code> <dev:remarks> <maml:para>Gets the available audio encoders.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioEncoderInfo.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioFile</command:name> <command:verb>Get</command:verb> <command:noun>AudioFile</command:noun> <maml:description> <maml:para>Gets an object that represents an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioFile cmdlet gets objects that represent audio files. Audio files expose metadata, and can be manipulated in various ways by the other AudioWorks cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcards are permitted. This parameter is required, but the parameter name ("Path") is optional.</maml:para> <maml:para>Use a dot (.) to specify the current location. Use the wildcard character (*) to specify all the items in the current location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AudioFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:Description> <maml:para>Specifies a path to the item. Unlike the Path parameter, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AudioFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>FileInfo</maml:name> <maml:Description> <maml:para>Specifies the file information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcards are permitted. This parameter is required, but the parameter name ("Path") is optional.</maml:para> <maml:para>Use a dot (.) to specify the current location. Use the wildcard character (*) to specify all the items in the current location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:Description> <maml:para>Specifies a path to the item. Unlike the Path parameter, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>FileInfo</maml:name> <maml:Description> <maml:para>Specifies the file information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcards are permitted. This parameter is required, but the parameter name ("Path") is optional.</maml:para> <maml:para>Use a dot (.) to specify the current location. Use the wildcard character (*) to specify all the items in the current location.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>Specifies the file information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get all audio files in the current directory with a specific extension</maml:title> <dev:code>PS C:\> $audioFiles = Get-AudioFile *.flac</dev:code> <dev:remarks> <maml:para>Gets all the flac files in the current directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get all audio files in a directory tree, recursively</maml:title> <dev:code>PS C:\> Get-ChildItem Music -Recurse -Filter *.flac | Get-AudioFile</dev:code> <dev:remarks> <maml:para>Gets all the flac files in the 'Music' directory recursively.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioFile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioInfo</command:name> <command:verb>Get</command:verb> <command:noun>AudioInfo</command:noun> <maml:description> <maml:para>Gets information about an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioInfo cmdlet gets information about audio files. This consists of immutable information that can't be changed without re-encoding the file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAudioFile</command:parameterValue> <dev:type> <maml:name>IAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAudioFile</command:parameterValue> <dev:type> <maml:name>IAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.IAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.AudioInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Get-AudioInfo Format : FLAC Channels : 2 BitsPerSample : 24 SampleRate : 96 kHz BitRate : 4608 kbps FrameCount : 16142465 PlayLength : 00:02:48</dev:code> <dev:remarks> <maml:para>Gets information about the audio stored in test.flac.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioInfo.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioMetadata</command:name> <command:verb>Get</command:verb> <command:noun>AudioMetadata</command:noun> <maml:description> <maml:para>Gets metadata describing an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioMetadata cmdlet gets information about audio files. This consists of fields that can be modified and optionally persisted to disk using other cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.AudioMetadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Get-AudioMetadata Title : Test Track Artist : Some Artist Album : Greatest Hits AlbumArtist : Composer : Genre : Rock Comment : Day : Month : Year : 2018 TrackNumber : 01 TrackCount : 10 TrackPeak : 0.956024 AlbumPeak : 1.000000 TrackGain : -2.94 dB AlbumGain : -7.65 dB</dev:code> <dev:remarks> <maml:para>Gets The metadata stored in test.flac.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioMetadata.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AudioMetadataEncoderInfo</command:name> <command:verb>Get</command:verb> <command:noun>AudioMetadataEncoderInfo</command:noun> <maml:description> <maml:para>Gets information about the available metadata encoders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AudioMetadataEncoderInfo cmdlet gets objects that describe the metadata encoders currently loaded and available for use with the Save-AudioMetadata cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AudioMetadataEncoderInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Api.AudioMetadataEncoderInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AudioMetadataEncoderInfo Extension Format Description --------- ------ ----------- .flac FLAC FLAC .mp3 ID3 ID3 version 2.x .m4a iTunes iTunes-compatible MPEG-4 .ogg Vorbis Vorbis Comments</dev:code> <dev:remarks> <maml:para>Gets the available audio metadata encoders.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Get-AudioMetadataEncoderInfo.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Measure-AudioFile</command:name> <command:verb>Measure</command:verb> <command:noun>AudioFile</command:noun> <maml:description> <maml:para>Analyzes an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Measure-AudioFile cmdlet performs analysis on an audio file, then stores these measurements as metadata.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Measure-AudioFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Analyzer</maml:name> <maml:Description> <maml:para>Specifies the type of analysis to perform.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxDegreeOfParallelism</maml:name> <maml:Description> <maml:para>Sets the maximum degree of parallelism.</maml:para> <maml:para>Defaults to the logical processor count.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Analyzer</maml:name> <maml:Description> <maml:para>Specifies the type of analysis to perform.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxDegreeOfParallelism</maml:name> <maml:Description> <maml:para>Sets the maximum degree of parallelism.</maml:para> <maml:para>Defaults to the logical processor count.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Analyze a single audio file ------------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Measure-AudioFile ReplayGain -PassTrue | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Performs ReplayGain analysis on test.flac, then saves the updated metadata to disk. Track and Album values will be the same.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Analyze a group of audio files together ------</maml:title> <dev:code>PS C:\> Get-AudioFile *.flac | Measure-AudioFile ReplayGain -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Performs ReplayGain analysis on all the flac files in the current directory, then saves the updated metadata to disk. For calculating album values, the files are treated as a one album.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Measure-AudioFile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Rename-AudioFile</command:name> <command:verb>Rename</command:verb> <command:noun>AudioFile</command:noun> <maml:description> <maml:para>Renames an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Rename-AudioFile cmdlet renames audio files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-AudioFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the new file name.</maml:para> <maml:para>The file extension will be selected automatically and should not be included.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify a name consisting of the track number, a hyphen, then the title, you would use "{TrackNumber} - {Title}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that existing files should be overwritten.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the new file name.</maml:para> <maml:para>The file extension will be selected automatically and should not be included.</maml:para> <maml:para>This parameter can reference metadata fields using {} braces. For example, to specify a name consisting of the track number, a hyphen, then the title, you would use "{TrackNumber} - {Title}".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that existing files should be overwritten.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Rename an audio file based on metadata ------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Rename-AudioFile "{TrackNumber} - {Title}"</dev:code> <dev:remarks> <maml:para>Renames test.flac with a file name composed of the track number and title.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Rename-AudioFile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-AudioMetadata</command:name> <command:verb>Save</command:verb> <command:noun>AudioMetadata</command:noun> <maml:description> <maml:para>Saves an audio file's metadata to disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Save-AudioMetadata cmdlet persists changes to an audio file's metadata.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AudioMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:Description> <maml:para>Specifies the metadata format to use.</maml:para> <maml:para>This is normally selected automatically based on the file extension. Explicitly specifying the format enables any dynamic parameters that are format-specific.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:Description> <maml:para>Specifies the metadata format to use.</maml:para> <maml:para>This is normally selected automatically based on the file extension. Explicitly specifying the format enables any dynamic parameters that are format-specific.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Clear an audio file's metadata, then save the changes</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Clear-AudioMetadata -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Clears all metadata fields from test.flac, then saves the changes to disk using default settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Save-AudioMetadata.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AudioMetadata</command:name> <command:verb>Set</command:verb> <command:noun>AudioMetadata</command:noun> <maml:description> <maml:para>Sets one or more metadata fields on an audio file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AudioMetadata cmdlet changes the value of one or more metadata fields. These changes are not persisted to disk unless followed by a call to Save-AudioMetadata.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AudioMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Sets the title.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Artist</maml:name> <maml:Description> <maml:para>Sets the artist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Album</maml:name> <maml:Description> <maml:para>Sets the album.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlbumArtist</maml:name> <maml:Description> <maml:para>Sets the album artist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Composer</maml:name> <maml:Description> <maml:para>Sets the composer.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Genre</maml:name> <maml:Description> <maml:para>Sets the genre.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:Description> <maml:para>Sets the comment.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Day</maml:name> <maml:Description> <maml:para>Sets the day of the month.</maml:para> <maml:para>Should be a number between 1 and 31.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Month</maml:name> <maml:Description> <maml:para>Sets the month.</maml:para> <maml:para>Should be a number between 1 and 12.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Year</maml:name> <maml:Description> <maml:para>Sets the year.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackNumber</maml:name> <maml:Description> <maml:para>Sets the track number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackCount</maml:name> <maml:Description> <maml:para>Sets the track number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CoverArt</maml:name> <maml:Description> <maml:para>Sets the cover art.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ICoverArt</command:parameterValue> <dev:type> <maml:name>ICoverArt</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AudioFile</maml:name> <maml:Description> <maml:para>Specifies the audio file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ITaggedAudioFile</command:parameterValue> <dev:type> <maml:name>ITaggedAudioFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Sets the title.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Artist</maml:name> <maml:Description> <maml:para>Sets the artist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Album</maml:name> <maml:Description> <maml:para>Sets the album.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlbumArtist</maml:name> <maml:Description> <maml:para>Sets the album artist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Composer</maml:name> <maml:Description> <maml:para>Sets the composer.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Genre</maml:name> <maml:Description> <maml:para>Sets the genre.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:Description> <maml:para>Sets the comment.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Day</maml:name> <maml:Description> <maml:para>Sets the day of the month.</maml:para> <maml:para>Should be a number between 1 and 31.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Month</maml:name> <maml:Description> <maml:para>Sets the month.</maml:para> <maml:para>Should be a number between 1 and 12.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Year</maml:name> <maml:Description> <maml:para>Sets the year.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackNumber</maml:name> <maml:Description> <maml:para>Sets the track number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrackCount</maml:name> <maml:Description> <maml:para>Sets the track number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CoverArt</maml:name> <maml:Description> <maml:para>Sets the cover art.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ICoverArt</command:parameterValue> <dev:type> <maml:name>ICoverArt</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para>Specifies the audio file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AudioWorks.Common.ITaggedAudioFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Update an audio file's metadata ----------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Set-AudioMetadata -Title "Testing 1-2-3" -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Sets the test.flac file's Title to "Testing 1-2-3", then saves the changes to disk.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 2: Update an audio file's cover art ---------</maml:title> <dev:code>PS C:\> Get-AudioFile test.flac | Set-AudioMetadata -CoverArt (Get-AudioCoverArt Folder.png) -PassThru | Save-AudioMetadata</dev:code> <dev:remarks> <maml:para>Sets the cover art in test.flac to the image retrieved from Folder.png, then saves the changes to disk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/blob/master/AudioWorks/src/AudioWorks.Commands/docs/Set-AudioMetadata.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AudioWorks Wiki</maml:linkText> <maml:uri>https://github.com/jherby2k/AudioWorks/wiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |