[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Imports an announcement file to the Announcement Service audio library.

Syntax


Import-CSAnnouncementFile [-Service] <ServiceId> -Content <Byte[]> -FileName <String> [-LocalStore][-WhatIf] [-Confirm]

Parameters

Parameter	Required	Type	Description
Parent	Required	String	The service ID of the Application Server on which the associated announcement service is running.
FileName	Required	String	The name that you want the file to have in the file store. You will use this name in the AudioFilePrompt parameter in the call to the New-CsAnnouncement or Set-CsAnnouncement cmdlet to assign the file to an announcement.
Content	Required	Byte[]	The contents of the audio file as a byte array.
Force	Optional	SwitchParameter	Suppresses any confirmation prompts that would otherwise be displayed before making changes.
WhatIf	Optional	SwitchParameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional	SwitchParameter	Prompts you for confirmation before executing the command.

Detailed Description

This cmdlet imports an audio file as a byte array to the Announcement Service audio library. This makes the file available for playback as an announcement for unassigned numbers.

Running this cmdlet imports the audio file to the library. After the file has been imported, the file can be used in an announcement by calling the New-CsAnnouncement or Set-CsAnnouncement cmdlet and passing the file name and associated service as parameters. At that point the New-CsUnassignedNumber or Set-CsUnassignedNumber cmdlet can be called to assign the announcement to a specific range of numbers.

Imported files must be WAV or WMA files.

Return Types

This cmdlet does not return a value.

Examples

-------------------------- Example 1 ------------------------

	Copy Code
$a = Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content $a

These commands import an audio file into the Announcement Service file store. Because audio files must be imported as byte arrays, we first need to call the Get-Content cmdlet to retrieve the audio file as an array of individual bytes. The Get-Content is a Windows PowerShell built-in cmdlet that we pass the name (including path) of the file we want to use for our announcement. Next we pass a value of 0 to the ReadCount parameter, meaning we want to read the whole file at once. We then pass a value of Byte to the Encoding parameter, which tells Get-Content that we want the contents of the file as an array of bytes. We assign that array to the variable $a.

In the second line we call the Import-CsAnnouncementFile cmdlet to actually import the file. We pass the service Identity ApplicationServer:redmond.litwareinc.com to the Parent parameter, then we pass a name to the FileName parameter (WelcomeMessage.wav). This can be any valid Microsoft Windows filename, but it should end with a .wav or .wma extension. Finally, we pass the variable $a as the value to the Content parameter to read in our byte array.

-------------------------- Example 2 ------------------------

	Copy Code
Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content (Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte)

Example 2 is identical to Example 1 except that we included the Get-Content command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable.