os/mm/mmlibs/mmfw/MIDI/inc/MmfMidi.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // Mmf\Common\MmfMidi.h
    15 // 
    16 //
    17 
    18 #ifndef __MMF_COMMON_MMFMIDI_H__
    19 #define __MMF_COMMON_MMFMIDI_H__
    20 
    21 // Standard EPOC32 includes
    22 #include <e32base.h>
    23 
    24 // Public Media Server includes
    25 #include <mmf/common/mmfbase.h>
    26 #include <mmf/common/mmfutilities.h>
    27 
    28 #include <midiclientutility.h>
    29 
    30 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    31 #include <mmf/common/mmfmidiconfig.h>
    32 #endif
    33 
    34 /**
    35 MIDI event usued by a MIDI controller to signal to a 
    36 client that a MIDI source open request has completed.
    37 
    38 @publishedAll
    39 @released
    40 */
    41 const TUid KMMFEventCategoryMidiOpenDataSourceComplete = {0x101F8F85};
    42 
    43 /**
    44 MIDI event used by a MIDI controller to signal to a 
    45 client that play of a MIDI resource has commenced.
    46 
    47 @publishedAll
    48 @released
    49 */
    50 const TUid KMMFEventCategoryMidiPlaying = {0x101F8F86};
    51 
    52 /**
    53 MIDI event used by a MIDI controller to signal to 
    54 a client that play of a MIDI resource has commenced 
    55 but not all SP-MIDI requirements can be met.
    56 
    57 @publishedAll
    58 @released
    59 */
    60 const TUid KMMFEventCategoryMidiPlaybackIncompatible = {0x101F8F87};
    61 
    62 /**
    63 MIDI event used by a MIDI controller to signal to a client that play
    64 of a MIDI resource has commenced but due to system resource constraints
    65 and SP-MIDI content constraints, there is no audible MIDI content
    66 during playback.
    67 
    68 @publishedAll
    69 @released
    70 */
    71 const TUid KMMFEventCategoryMidiPlaybackSilent = {0x101F8F88};
    72 
    73 /**
    74 MIDI event used by a MIDI controller to signal to
    75 a client that play of a MIDI resource has completed.
    76 
    77 @publishedAll
    78 @released
    79 */
    80 const TUid KMMFEventCategoryMidiPlayingComplete = {0x101F8F89};
    81 
    82 /**
    83 MIDI event used by a MIDI controller to signal to
    84 a client a sync update event. The frequency of this event is
    85 set by the client with SetSyncUpdateCallbackIntervalL.
    86 
    87 @publishedAll
    88 @released
    89 */
    90 const TUid KMMFEventCategoryMidiSyncUpdate = {0x101F8F8A};
    91 
    92 /**
    93 MIDI event used by a MIDI controller to signal to
    94 a client that any currently opened resources have been closed.
    95 
    96 @publishedAll
    97 @released
    98 */
    99 const TUid KMMFEventCategoryMidiClose = {0x101F8F8B};
   100 
   101 /**
   102 MIDI event used by a MIDI controller to signal to a client that the 
   103 MIDI controller has been primed and it's ready to play.
   104 
   105 @publishedAll
   106 @released
   107 */
   108 const TUid KMMFEventCategoryMidiPrime = {0x101F8F8C};
   109 
   110 /**
   111 MIDI event used by a MIDI controller to signal to a client that the MIDI
   112 resource has encountered a tempo change message in the MIDI data stream.
   113 
   114 @publishedAll
   115 @released
   116 */
   117 const TUid KMMFEventCategoryTempoChanged = {0x101F8F8D};
   118 
   119 /**
   120 MIDI event used by a MIDI controller to signal to a client that the MIDI
   121 resource has encountered a volume change message in the MIDI data stream.
   122 
   123 @publishedAll
   124 @released
   125 */
   126 const TUid KMMFEventCategoryVolumeChanged = {0x101F8F8E};
   127 
   128 /**
   129 MIDI event used by a MIDI controller to signal to a client that the 
   130 MIDI resource has encountered a mute message in the MIDI data stream.
   131 
   132 @publishedAll
   133 @released
   134 */
   135 const TUid KMMFEventCategoryMuteChanged = {0x101F8F8F};
   136 
   137 /**
   138 MIDI event used by a MIDI controller to signal to a client that the polyphony
   139 of the MIDI engine has changed.
   140 
   141 @publishedAll
   142 @released
   143 */
   144 const TUid KMMFEventCategoryPolyphonyChanged = {0x101F8F90};
   145 
   146 /**
   147 MIDI event used by a MIDI controller to signal to a client that
   148 an instrument has been changed on a channel.
   149 
   150 @publishedAll
   151 @released
   152 */
   153 const TUid KMMFEventCategoryInstrumentChanged = {0x101F8F91};
   154 
   155 /**
   156 MIDI event used by a MIDI controller to signal to a client that a timed
   157 meta data entry has been found in the MIDI data stream.
   158 
   159 @publishedAll
   160 @released
   161 */
   162 const TUid KMMFEventCategoryMetaDataEntryFound  = {0x101F8F92};
   163 
   164 /**
   165 MIDI event used by a MIDI controller to signal to a client that a 
   166 MIP message has been found in the MIDI data stream.
   167 
   168 @publishedAll
   169 @released
   170 */
   171 const TUid KMMFEventCategoryMipMessageReceived  = {0x101F8F93};
   172 
   173 #endif