Represents a midi output device.
More...
#include <juce_MidiDevices.h>
|
| static bool | currentThreadShouldExit () |
| | Checks whether the current thread has been told to stop running.
|
| |
| static Thread * | getCurrentThread () |
| | Finds the thread object that is currently running.
|
| |
| static ThreadID | getCurrentThreadId () |
| | Returns an id that identifies the caller thread.
|
| |
| static void | initialiseJUCE (void *jniEnv, void *jContext) |
| | Initialises the JUCE subsystem for projects not created by the Projucer.
|
| |
| static bool | launch (Priority priority, std::function< void()> functionToRun) |
| | Invokes a lambda or function on its own thread with a custom priority.
|
| |
| static bool | launch (std::function< void()> functionToRun) |
| | Invokes a lambda or function on its own thread with the default priority.
|
| |
| static void | setCurrentThreadAffinityMask (uint32 affinityMask) |
| | Changes the affinity mask for the caller thread.
|
| |
| static void | setCurrentThreadName (const String &newThreadName) |
| | Changes the name of the caller thread.
|
| |
| static void | sleep (int milliseconds) |
| | Suspends the execution of the current thread until the specified timeout period has elapsed (note that this may not be exact).
|
| |
| static void | yield () |
| | Yields the current thread's CPU time-slot and allows a new thread to run.
|
| |
Represents a midi output device.
To create one of these, use the static getAvailableDevices() method to find out what outputs are available, and then use the openDevice() method to try to open one.
- See also
- MidiInput
@tags{Audio}
◆ ThreadID
◆ Priority
The different runtime priorities of non-realtime threads.
- See also
- startThread
| Enumerator |
|---|
| highest | The highest possible priority that isn't a dedicated realtime thread.
|
| high | Makes use of performance cores and higher clocks.
|
| normal | The OS default.
It will balance out across all cores.
|
| low | Uses efficiency cores when possible.
|
| background | Restricted to efficiency cores on platforms that have them.
|
◆ ~MidiOutput()
| juce::MidiOutput::~MidiOutput |
( |
| ) |
|
|
override |
◆ MidiOutput()
| juce::MidiOutput::MidiOutput |
( |
const String & |
, |
|
|
const String & |
|
|
) |
| |
|
explicitprivate |
◆ addListener()
| void juce::Thread::addListener |
( |
Listener * |
| ) |
|
|
inherited |
◆ clearAllPendingMessages()
| void juce::MidiOutput::clearAllPendingMessages |
( |
| ) |
|
◆ closeThreadHandle()
| void juce::Thread::closeThreadHandle |
( |
| ) |
|
|
privateinherited |
◆ createNativeThread()
◆ createNewDevice()
| static std::unique_ptr< MidiOutput > juce::MidiOutput::createNewDevice |
( |
const String & |
deviceName | ) |
|
|
static |
This will try to create a new midi output device (only available on Linux, macOS and iOS).
This will attempt to create a new midi output device with the specified name that other apps can connect to and use as their midi input.
NB - if you are calling this method on iOS you must have enabled the "Audio Background Capability" setting in the iOS exporter otherwise this method will fail.
Returns an empty object if a device can't be created.
- Parameters
-
| deviceName | the name of the device to create |
◆ currentThreadShouldExit()
| static bool juce::Thread::currentThreadShouldExit |
( |
| ) |
|
|
staticinherited |
Checks whether the current thread has been told to stop running.
On the message thread, this will always return false, otherwise it will return threadShouldExit() called on the current thread.
- See also
- threadShouldExit
◆ getAvailableDevices()
Returns a list of the available midi output devices.
You can open one of the devices by passing its identifier into the openDevice() method.
- See also
- MidiDeviceInfo, getDevices, getDefaultDeviceIndex, openDevice
◆ getCurrentThread()
| static Thread * juce::Thread::getCurrentThread |
( |
| ) |
|
|
staticinherited |
Finds the thread object that is currently running.
Note that the main UI thread (or other non-JUCE threads) don't have a Thread object associated with them, so this will return nullptr.
◆ getCurrentThreadId()
◆ getDefaultDevice()
◆ getDeviceInfo()
Returns the MidiDeviceInfo struct containing some information about this device.
◆ getIdentifier()
| String juce::MidiOutput::getIdentifier |
( |
| ) |
const |
|
inlinenoexcept |
Returns the identifier of this device.
◆ getName()
| String juce::MidiOutput::getName |
( |
| ) |
const |
|
inlinenoexcept |
Returns the name of this device.
◆ getPriority()
| Priority juce::Thread::getPriority |
( |
| ) |
const |
|
protectedinherited |
Returns the current priority of this thread.
This can only be called from the target thread. Doing so from another thread will cause an assert.
- See also
- setPriority
◆ getThreadId()
| ThreadID juce::Thread::getThreadId |
( |
| ) |
const |
|
noexceptinherited |
Returns the ID of this thread.
That means the ID of this thread object - not of the thread that's calling the method. This can change when the thread is started and stopped, and will be invalid if the thread's not actually running.
- See also
- getCurrentThreadId
◆ getThreadName()
| const String & juce::Thread::getThreadName |
( |
| ) |
const |
|
inlinenoexceptinherited |
Returns the name of the thread.
This is the name that gets set in the constructor.
◆ initialiseJUCE()
| static void juce::Thread::initialiseJUCE |
( |
void * |
jniEnv, |
|
|
void * |
jContext |
|
) |
| |
|
staticinherited |
Initialises the JUCE subsystem for projects not created by the Projucer.
On Android, JUCE needs to be initialised once before it is used. The Projucer will automatically generate the necessary java code to do this. However, if you are using JUCE without the Projucer or are creating a library made with JUCE intended for use in non-JUCE apks, then you must call this method manually once on apk startup.
You can call this method from C++ or directly from java by calling the following java method:
com.rmsl.juce.Java.initialiseJUCE (myContext);
Note that the above java method is only available in Android Studio projects created by the Projucer. If you need to call this from another type of project then you need to add the following java file to your project:
package com.rmsl.juce;
public class Java
{
static { System.loadLibrary ("juce_jni"); }
public native static void initialiseJUCE (Context context);
}
- Parameters
-
| jniEnv | this is a pointer to JNI's JNIEnv variable. Any callback from Java into C++ will have this passed in as it's first parameter. |
| jContext | this is a jobject referring to your app/service/receiver/ provider's Context. JUCE needs this for many of it's internal functions. |
◆ isBackgroundThreadRunning()
| bool juce::MidiOutput::isBackgroundThreadRunning |
( |
| ) |
const |
|
inlinenoexcept |
◆ isRealtime()
| bool juce::Thread::isRealtime |
( |
| ) |
const |
|
inherited |
Returns true if this Thread represents a realtime thread.
◆ isThreadRunning()
| bool juce::Thread::isThreadRunning |
( |
| ) |
const |
|
inherited |
◆ killThread()
| void juce::Thread::killThread |
( |
| ) |
|
|
privateinherited |
◆ launch() [1/2]
| static bool juce::Thread::launch |
( |
Priority |
priority, |
|
|
std::function< void()> |
functionToRun |
|
) |
| |
|
staticinherited |
Invokes a lambda or function on its own thread with a custom priority.
This will spin up a Thread object which calls the function and then exits. Bear in mind that starting and stopping a thread can be a fairly heavyweight operation, so you might prefer to use a ThreadPool if you're kicking off a lot of short background tasks.
Also note that using an anonymous thread makes it very difficult to interrupt the function when you need to stop it, e.g. when your app quits. So it's up to you to deal with situations where the function may fail to stop in time.
- Parameters
-
| priority | The priority the thread is started with. |
| functionToRun | The lambda to be called from the new Thread. |
- Returns
- true if the thread started successfully, or false if it failed.
◆ launch() [2/2]
| static bool juce::Thread::launch |
( |
std::function< void()> |
functionToRun | ) |
|
|
staticinherited |
Invokes a lambda or function on its own thread with the default priority.
This will spin up a Thread object which calls the function and then exits. Bear in mind that starting and stopping a thread can be a fairly heavyweight operation, so you might prefer to use a ThreadPool if you're kicking off a lot of short background tasks.
Also note that using an anonymous thread makes it very difficult to interrupt the function when you need to stop it, e.g. when your app quits. So it's up to you to deal with situations where the function may fail to stop in time.
- Parameters
-
| functionToRun | The lambda to be called from the new Thread. |
- Returns
- true if the thread started successfully, or false if it failed.
- See also
- launch.
◆ notify()
| void juce::Thread::notify |
( |
| ) |
const |
|
inherited |
Wakes up the thread.
If the thread has called the wait() method, this will wake it up.
- See also
- wait
◆ openDevice()
| static std::unique_ptr< MidiOutput > juce::MidiOutput::openDevice |
( |
const String & |
deviceIdentifier | ) |
|
|
static |
Tries to open one of the midi output devices.
This will return a MidiOutput object if it manages to open it, you can then send messages to this device.
If the device can't be opened, this will return an empty object.
- Parameters
-
| deviceIdentifier | the ID of the device to open - use the getAvailableDevices() method to find the available devices that can be opened |
- See also
- getDevices
◆ removeListener()
| void juce::Thread::removeListener |
( |
Listener * |
| ) |
|
|
inherited |
Removes a listener added with addListener.
◆ run()
| void juce::MidiOutput::run |
( |
| ) |
|
|
overrideprivatevirtual |
Must be implemented to perform the thread's actual code.
Remember that the thread must regularly check the threadShouldExit() method whilst running, and if this returns true it should return from the run() method as soon as possible to avoid being forcibly killed.
- See also
- threadShouldExit, startThread
Implements juce::Thread.
◆ sendBlockOfMessages()
| void juce::MidiOutput::sendBlockOfMessages |
( |
const MidiBuffer & |
buffer, |
|
|
double |
millisecondCounterToStartAt, |
|
|
double |
samplesPerSecondForBuffer |
|
) |
| |
This lets you supply a block of messages that will be sent out at some point in the future.
The MidiOutput class has an internal thread that can send out timestamped messages - this appends a set of messages to its internal buffer, ready for sending.
This will only work if you've already started the thread with startBackgroundThread().
A time is specified, at which the block of messages should be sent. This time uses the same time base as Time::getMillisecondCounter(), and must be in the future.
The samplesPerSecondForBuffer parameter indicates the number of samples per second used by the MidiBuffer. Each event in a MidiBuffer has a sample position, and the samplesPerSecondForBuffer value is needed to convert this sample position to a real time.
◆ sendBlockOfMessagesNow()
| void juce::MidiOutput::sendBlockOfMessagesNow |
( |
const MidiBuffer & |
buffer | ) |
|
Sends out a sequence of MIDI messages immediately.
◆ sendMessageNow()
| void juce::MidiOutput::sendMessageNow |
( |
const MidiMessage & |
message | ) |
|
Sends out a MIDI message immediately.
◆ setAffinityMask()
| void juce::Thread::setAffinityMask |
( |
uint32 |
affinityMask | ) |
|
|
inherited |
Sets the affinity mask for the thread.
This will only have an effect next time the thread is started - i.e. if the thread is already running when called, it'll have no effect.
- See also
- setCurrentThreadAffinityMask
◆ setCurrentThreadAffinityMask()
| void juce::Thread::setCurrentThreadAffinityMask |
( |
uint32 |
affinityMask | ) |
|
|
staticinherited |
◆ setCurrentThreadName()
| void juce::Thread::setCurrentThreadName |
( |
const String & |
newThreadName | ) |
|
|
staticinherited |
Changes the name of the caller thread.
Different OSes may place different length or content limits on this name.
References JUCE_AUTORELEASEPOOL.
◆ setName()
| void juce::MidiOutput::setName |
( |
const String & |
newName | ) |
|
|
inlinenoexcept |
Sets a custom name for the device.
◆ setPriority()
Attempts to set the priority for this thread.
Returns true if the new priority was set successfully, false if not.
This can only be called from the target thread. Doing so from another thread will cause an assert.
- Parameters
-
| newPriority | The new priority to be applied to the thread. Note: This has no effect on Linux platforms, subsequent calls to 'getPriority' will return this value. |
- See also
- Priority
◆ signalThreadShouldExit()
| void juce::Thread::signalThreadShouldExit |
( |
| ) |
|
|
inherited |
◆ sleep()
| void juce::Thread::sleep |
( |
int |
milliseconds | ) |
|
|
staticinherited |
◆ startBackgroundThread()
| void juce::MidiOutput::startBackgroundThread |
( |
| ) |
|
Starts up a background thread so that the device can send blocks of data.
Call this to get the device ready, before using sendBlockOfMessages().
◆ startRealtimeThread()
Starts the thread with realtime performance characteristics on platforms that support it.
You cannot change the options of a running realtime thread, nor switch a non-realtime thread to a realtime thread. To make these changes you must first stop the thread and then restart with different options.
- Parameters
-
| options | Realtime options the thread should be created with. |
- See also
- startThread, RealtimeOptions
◆ startThread() [1/2]
| bool juce::Thread::startThread |
( |
| ) |
|
|
inherited |
Attempts to start a new thread with default ('Priority::normal') priority.
This will cause the thread's run() method to be called by a new thread. If this thread is already running, startThread() won't do anything.
If a thread cannot be created with the requested priority, this will return false and Thread::run() will not be called. An exception to this is the Android platform, which always starts a thread and attempts to upgrade the thread after creation.
- Returns
- true if the thread started successfully. false if it was unsuccessful.
- See also
- stopThread
Referenced by juce::detail::MessageThread::start().
◆ startThread() [2/2]
Attempts to start a new thread with a given priority.
This will cause the thread's run() method to be called by a new thread. If this thread is already running, startThread() won't do anything.
If a thread cannot be created with the requested priority, this will return false and Thread::run() will not be called. An exception to this is the Android platform, which always starts a thread and attempts to upgrade the thread after creation.
- Parameters
-
| newPriority | Priority the thread should be assigned. This parameter is ignored on Linux. |
- Returns
- true if the thread started successfully, false if it was unsuccesful.
- See also
- startThread, setPriority, startRealtimeThread
◆ startThreadInternal()
◆ stopBackgroundThread()
| void juce::MidiOutput::stopBackgroundThread |
( |
| ) |
|
◆ stopThread()
| bool juce::Thread::stopThread |
( |
int |
timeOutMilliseconds | ) |
|
|
inherited |
Attempts to stop the thread running.
This method will cause the threadShouldExit() method to return true and call notify() in case the thread is currently waiting.
Hopefully the thread will then respond to this by exiting cleanly, and the stopThread method will wait for a given time-period for this to happen.
If the thread is stuck and fails to respond after the timeout, it gets forcibly killed, which is a very bad thing to happen, as it could still be holding locks, etc. which are needed by other parts of your program.
- Parameters
-
| timeOutMilliseconds | The number of milliseconds to wait for the thread to finish before killing it by force. A negative value in here will wait forever. |
- Returns
- true if the thread was cleanly stopped before the timeout, or false if it had to be killed by force.
- See also
- signalThreadShouldExit, threadShouldExit, waitForThreadToExit, isThreadRunning
Referenced by juce::detail::MessageThread::stop().
◆ threadEntryPoint()
| void juce::Thread::threadEntryPoint |
( |
| ) |
|
|
privateinherited |
◆ threadShouldExit()
| bool juce::Thread::threadShouldExit |
( |
| ) |
const |
|
inherited |
◆ wait()
| bool juce::Thread::wait |
( |
double |
timeOutMilliseconds | ) |
const |
|
inherited |
Suspends the execution of this thread until either the specified timeout period has elapsed, or another thread calls the notify() method to wake it up.
A negative timeout value means that the method will wait indefinitely.
- Returns
- true if the event has been signalled, false if the timeout expires.
◆ waitForThreadToExit()
| bool juce::Thread::waitForThreadToExit |
( |
int |
timeOutMilliseconds | ) |
const |
|
inherited |
Waits for the thread to stop.
This will wait until isThreadRunning() is false or until a timeout expires.
- Parameters
-
| timeOutMilliseconds | the time to wait, in milliseconds. If this value is less than zero, it will wait forever. |
- Returns
- true if the thread exits, or false if the timeout expires first.
◆ yield()
| void juce::Thread::yield |
( |
| ) |
|
|
staticinherited |
Yields the current thread's CPU time-slot and allows a new thread to run.
If there are no other threads of equal or higher priority currently running then this will return immediately and the current thread will continue to run.
◆ affinityMask
| uint32 juce::Thread::affinityMask = 0 |
|
privateinherited |
◆ defaultEvent
◆ deleteOnThreadEnd
| bool juce::Thread::deleteOnThreadEnd = false |
|
privateinherited |
◆ deviceInfo
◆ firstMessage
◆ internal
| std::unique_ptr<Pimpl> juce::MidiOutput::internal |
|
private |
◆ listeners
◆ lock
◆ osDefaultStackSize
| constexpr size_t juce::Thread::osDefaultStackSize { 0 } |
|
staticconstexprinherited |
◆ priority
| std::atomic<Priority> juce::Thread::priority |
|
privateinherited |
◆ realtimeOptions
◆ shouldExit
| std::atomic<bool> juce::Thread::shouldExit { false } |
|
privateinherited |
◆ startStopLock
◆ startSuspensionEvent
◆ threadHandle
| std::atomic<void*> juce::Thread::threadHandle { nullptr } |
|
privateinherited |
◆ threadId
| std::atomic<ThreadID> juce::Thread::threadId { nullptr } |
|
privateinherited |
◆ threadName
| const String juce::Thread::threadName |
|
privateinherited |
◆ threadStackSize
| size_t juce::Thread::threadStackSize |
|
privateinherited |
The documentation for this class was generated from the following file: