1. Introduction

This package contains the VoiceChat (VCT) Library that runs on CTR systems. It allows chat sessions by sending and receiving audio between CTR systems.

You can also use this package in your products.

It is guaranteed to operate with eight systems.

2. Notes

Before building the sample demo, run omake from $CTRPIA_ROOT/sampledemos/SampleLib to create lib_SampleLib.fast.a. To build the sample demos, set the CTRMW_VCT_ROOT environment variable then go to the sampledemos directory to run omake from the command line.
If you specify the build type (debug, development, release) in the BUILD variable when you run omake, you can build three versions (the Debug version, Development version, or Release version).
The executable file is created as sampledemos/(demo_name)/images/CTR-TS.Process.MPCore.fast/(Debug|Development|Release)/(demo_name).cci.

The High Performance Echo Canceller is an evaluation version, and can only be used on development hardware (debug mode). On retail systems, standard mode is forcibly selected. Even standard mode achieves product-level echo canceling.
Contact support@noa.com if you are considering the use of the High Performance Echo Canceller in a retail product.

3. Copyright Notice

For more information about copyright notation when embedding this middleware in an application, see the following documentation.

Guidelines for Printed Materials
E-Manual Creation Guide included in the CTR E-Manual Template Collection

4. System Requirements

The following development environment is required to run this package.

CTR-SDK
Communication library for features such as CTR-Pia and CTR-NEX. (This library is required for the sample demo to work.)
ARMCC 4.1 for Nintendo

5. Operating Environment

This package has been confirmed to run on the following versions of the development environment.

CTR-SDK 7.1.1
CTR-NEX 3.6.1
CTR-Pia 3.6.0
ARMCC 4.1 for Nintendo Version 2012/10/26 Build 1049 release

6. Installation

Package Location

Extract this package and place it in any directory. We recommend you place it in a directory whose path does not include spaces or double-byte characters. Once you have put the package in the chosen directory, run SetupCTR.wsf to set the absolute path to the root directory of the package to the CTRMW_VCT_ROOT environment variable.

Incorporating This Library Into Your Application

Link to the following header files and libraries to include this middleware in an application.

Header File: include/mw/vct/vct.h
Libraries: libraries/CTR-TS.Process.MPCore/(noopt|release|verbose)/libmw_vct.fast.a

Only the fast build library is included in this package.
P2P communication, where the CPU load can easily create a bottleneck, normally uses only the fast build. For this reason, and also to fully verify the fast build, the small build is not included. If you need the small build, please contact Nintendo.

7. Known Bugs

None

The latest information, including bugs that have been uncovered since the last release, can be viewed in the Technical Information section of the Developer Support website.

8. Package Structure

The structure of this package is outlined below.
Note: This does not list all included files.

CTR_MW-VCT/
    |
    +- documents/
    |    |
    |    +- API/
    |    |    |
    |    |    +- html/
    |    |         |
    |    |         +- index.html ... Function Reference
    |    |
    |    +- ProgrammingManual/
    |    |    |
    |    |    +- CTR/
    |    |         |
    |    |         +- index.html ... Programming Manual
    |    |
    |    +- ReleaseNotes/
    |         |
    |         +- ChangeLog-CTR_VCT-2_0_2-en.txt ... Revision History
    |
    +- include/
    |    |
    |    +- mw/
    |         |
    |         +- vct/
    |              |
    |              +- vct.h ... Header file
    |
    +- libraries/
    |    |
    |    +- CTR-TS.Process.MPCore/
    |         |
    |         +- (noopt|release|verbose)/
    |              |
    |              +- libmw_vct.fast.a ... Library file
    |
    +- sampledemos/ ... Sample demos
    |    |
    |    +- vct_sample/
    |         |
    |         +- include/  ... Include files
    |         +- romfiles/ ... ROM data
    |         +- src/      ... Source files
    |
    +- Readme-CTR_MW-VCT-2_0_2-en.html ... Readme file
    |
    +- SetupCTR.wsf ... Environment variable configuration script file

9. Associated Documentation

For more information about this middleware's specifications and how to use the tools, see the VCT Library Programming Manual.

For more information about the functions and how to run the sample demos, see the Function Reference.

10. Revision History

For the revision history, see ChangeLog-CTR_VCT-2_0_2-en.txt.

CONFIDENTIAL

Contents