OpenShot Audio Library | OpenShotAudio: juce::SystemStats Class Reference

OpenShot Audio Library | OpenShotAudio 0.3.2

Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
juce::SystemStats Class Referencefinal

`#include <juce_SystemStats.h>`

## Public Types
enum | OperatingSystemType { UnknownOS = 0 , MacOSX = 0x0100 , Windows = 0x0200 , Linux = 0x0400 , Android = 0x0800 , iOS = 0x1000 , MacOSX_10_4 = MacOSX | 4 , MacOSX_10_5 = MacOSX | 5 , MacOSX_10_6 = MacOSX | 6 , MacOSX_10_7 = MacOSX | 7 , MacOSX_10_8 = MacOSX | 8 , MacOSX_10_9 = MacOSX | 9 , MacOSX_10_10 = MacOSX | 10 , MacOSX_10_11 = MacOSX | 11 , MacOSX_10_12 = MacOSX | 12 , MacOSX_10_13 = MacOSX | 13 , MacOSX_10_14 = MacOSX | 14 , Win2000 = Windows | 1 , WinXP = Windows | 2 , WinVista = Windows | 3 , Windows7 = Windows | 4 , Windows8_0 = Windows | 5 , Windows8_1 = Windows | 6 , Windows10 = Windows | 7 }
using | CrashHandlerFunction = void(*)(void *)

## Static Public Member Functions
static String | getJUCEVersion ()
static OperatingSystemType | getOperatingSystemType ()
static String | getOperatingSystemName ()
static bool | isOperatingSystem64Bit ()
static String | getEnvironmentVariable (const String &name, const String &defaultValue)
static String | getLogonName ()
static String | getFullUserName ()
static String | getComputerName ()
static String | getUserLanguage ()
static String | getUserRegion ()
static String | getDisplayLanguage ()
static String | getDeviceDescription ()
static String | getDeviceManufacturer ()
static StringArray | getDeviceIdentifiers ()
static int | getNumCpus () noexcept
static int | getNumPhysicalCpus () noexcept
static int | getCpuSpeedInMegahertz ()
static String | getCpuVendor ()
static String | getCpuModel ()
static bool | hasMMX () noexcept
static bool | has3DNow () noexcept
static bool | hasFMA3 () noexcept
static bool | hasFMA4 () noexcept
static bool | hasSSE () noexcept
static bool | hasSSE2 () noexcept
static bool | hasSSE3 () noexcept
static bool | hasSSSE3 () noexcept
static bool | hasSSE41 () noexcept
static bool | hasSSE42 () noexcept
static bool | hasAVX () noexcept
static bool | hasAVX2 () noexcept
static bool | hasAVX512F () noexcept
static bool | hasAVX512BW () noexcept
static bool | hasAVX512CD () noexcept
static bool | hasAVX512DQ () noexcept
static bool | hasAVX512ER () noexcept
static bool | hasAVX512IFMA () noexcept
static bool | hasAVX512PF () noexcept
static bool | hasAVX512VBMI () noexcept
static bool | hasAVX512VL () noexcept
static bool | hasAVX512VPOPCNTDQ () noexcept
static bool | hasNeon () noexcept
static int | getMemorySizeInMegabytes ()
static int | getPageSize ()
static String | getStackBacktrace ()
static void | setApplicationCrashHandler (CrashHandlerFunction)
static bool | isRunningInAppExtensionSandbox () noexcept

## Detailed Description

Contains methods for finding out about the current hardware and OS configuration.

Definition at line 32 of file juce_SystemStats.h.

## Member Typedef Documentation

## ◆ CrashHandlerFunction

using juce::SystemStats::CrashHandlerFunction = void(*)(void*)

A function type for use in setApplicationCrashHandler(). When called, its void* argument will contain platform-specific data about the crash.

Definition at line 219 of file juce_SystemStats.h.

## Member Enumeration Documentation

## ◆ OperatingSystemType

enum juce::SystemStats::OperatingSystemType

The set of possible results of the getOperatingSystemType() method.

Enumerator
MacOSX | To test whether any version of OSX is running, you can use the expression ((getOperatingSystemType() & MacOSX) != 0).
Windows | To test whether any version of Windows is running, you can use the expression ((getOperatingSystemType() & Windows) != 0).

Definition at line 43 of file juce_SystemStats.h.

## Member Function Documentation

## ◆ getComputerName()

static String juce::SystemStats::getComputerName | ( |  | ) |
| static

Returns the host-name of the computer.

## ◆ getCpuModel()

static String juce::SystemStats::getCpuModel | ( |  | ) |
| static

Attempts to return a string describing the CPU model. May not be available on some systems.

## ◆ getCpuSpeedInMegahertz()

static int juce::SystemStats::getCpuSpeedInMegahertz | ( |  | ) |
| static

Returns the approximate CPU speed.

Returns
  the speed in megahertz, e.g. 1500, 2500, 32000 (depending on what year you're reading this...)

## ◆ getCpuVendor()

static String juce::SystemStats::getCpuVendor | ( |  | ) |
| static

Returns a string to indicate the CPU vendor. Might not be known on some systems.

## ◆ getDeviceDescription()

static String juce::SystemStats::getDeviceDescription | ( |  | ) |
| static

This will attempt to return some kind of string describing the device. If no description is available, it'll just return an empty string. You may want to use this for things like determining the type of phone/iPad, etc.

## ◆ getDeviceIdentifiers()

StringArray juce::SystemStats::getDeviceIdentifiers | ( |  | ) |
| static

This method calculates some IDs to uniquely identify the device.

The first choice for an ID is a filesystem ID for the user's home folder or windows directory. If that fails then this function returns the MAC addresses.

Definition at line 61 of file juce_SystemStats.cpp.

## ◆ getDeviceManufacturer()

static String juce::SystemStats::getDeviceManufacturer | ( |  | ) |
| static

This will attempt to return the manufacturer of the device. If no description is available, it'll just return an empty string.

## ◆ getDisplayLanguage()

static String juce::SystemStats::getDisplayLanguage | ( |  | ) |
| static

Returns the user's display language. The return value is a 2 or 3 letter language code (ISO 639-1 or ISO 639-2). Note that depending on the OS and region, this may also be followed by a dash and a sub-region code, e.g "en-GB"

## ◆ getEnvironmentVariable()

static String juce::SystemStats::getEnvironmentVariable | ( | const String & | name,
|  | const String & | defaultValue
| ) |  |
| static

Returns an environment variable. If the named value isn't set, this will return the defaultValue string instead.

## ◆ getFullUserName()

static String juce::SystemStats::getFullUserName | ( |  | ) |
| static

Returns the current user's full name, if available. On some OSes, this may just return the same value as getLogonName().

See also
  getLogonName()

## ◆ getJUCEVersion()

String juce::SystemStats::getJUCEVersion | ( |  | ) |
| static

Returns the current version of JUCE, See also the JUCE_VERSION, JUCE_MAJOR_VERSION and JUCE_MINOR_VERSION macros.

Definition at line 26 of file juce_SystemStats.cpp.

## ◆ getLogonName()

static String juce::SystemStats::getLogonName | ( |  | ) |
| static

Returns the current user's name, if available.

See also
  getFullUserName()

## ◆ getMemorySizeInMegabytes()

static int juce::SystemStats::getMemorySizeInMegabytes | ( |  | ) |
| static

Finds out how much RAM is in the machine.

Returns
  the approximate number of megabytes of memory, or zero if something goes wrong when finding out.

## ◆ getNumCpus()

int juce::SystemStats::getNumCpus | ( |  | ) |
| staticnoexcept

Returns the number of logical CPU cores.

Definition at line 109 of file juce_SystemStats.cpp.

Referenced by juce::ThreadPool::ThreadPool().

## ◆ getNumPhysicalCpus()

int juce::SystemStats::getNumPhysicalCpus | ( |  | ) |
| staticnoexcept

Returns the number of physical CPU cores.

Definition at line 110 of file juce_SystemStats.cpp.

## ◆ getOperatingSystemName()

static String juce::SystemStats::getOperatingSystemName | ( |  | ) |
| static

Returns the name of the type of operating system we're running on.

Returns
  a string describing the OS type.

See also
  getOperatingSystemType

## ◆ getOperatingSystemType()

static OperatingSystemType juce::SystemStats::getOperatingSystemType | ( |  | ) |
| static

Returns the type of operating system we're running on.

Returns
  one of the values from the OperatingSystemType enum.

See also
  getOperatingSystemName

## ◆ getPageSize()

static int juce::SystemStats::getPageSize | ( |  | ) |
| static

Returns the system page-size. This is only used by programmers with beards.

## ◆ getStackBacktrace()

String juce::SystemStats::getStackBacktrace | ( |  | ) |
| static

Returns a backtrace of the current call-stack. The usefulness of the result will depend on the level of debug symbols that are available in the executable.

Definition at line 137 of file juce_SystemStats.cpp.

## ◆ getUserLanguage()

static String juce::SystemStats::getUserLanguage | ( |  | ) |
| static

Returns the language of the user's locale. The return value is a 2 or 3 letter language code (ISO 639-1 or ISO 639-2)

## ◆ getUserRegion()

static String juce::SystemStats::getUserRegion | ( |  | ) |
| static

Returns the region of the user's locale. The return value is a 2 letter country code (ISO 3166-1 alpha-2).

## ◆ has3DNow()

bool juce::SystemStats::has3DNow | ( |  | ) |
| staticnoexcept

Returns true if AMD 3DNOW instructions are available.

Definition at line 112 of file juce_SystemStats.cpp.

## ◆ hasAVX()

bool juce::SystemStats::hasAVX | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX instructions are available.

Definition at line 121 of file juce_SystemStats.cpp.

## ◆ hasAVX2()

bool juce::SystemStats::hasAVX2 | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX2 instructions are available.

Definition at line 122 of file juce_SystemStats.cpp.

## ◆ hasAVX512BW()

bool juce::SystemStats::hasAVX512BW | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Byte and Word instructions are available.

Definition at line 124 of file juce_SystemStats.cpp.

## ◆ hasAVX512CD()

bool juce::SystemStats::hasAVX512CD | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Conflict Detection instructions are available.

Definition at line 125 of file juce_SystemStats.cpp.

## ◆ hasAVX512DQ()

bool juce::SystemStats::hasAVX512DQ | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Doubleword and Quadword instructions are available.

Definition at line 126 of file juce_SystemStats.cpp.

## ◆ hasAVX512ER()

bool juce::SystemStats::hasAVX512ER | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Exponential and Reciprocal instructions are available.

Definition at line 127 of file juce_SystemStats.cpp.

## ◆ hasAVX512F()

bool juce::SystemStats::hasAVX512F | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Foundation instructions are available.

Definition at line 123 of file juce_SystemStats.cpp.

## ◆ hasAVX512IFMA()

bool juce::SystemStats::hasAVX512IFMA | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Integer Fused Multiply-Add instructions are available.

Definition at line 128 of file juce_SystemStats.cpp.

## ◆ hasAVX512PF()

bool juce::SystemStats::hasAVX512PF | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Prefetch instructions are available.

Definition at line 129 of file juce_SystemStats.cpp.

## ◆ hasAVX512VBMI()

bool juce::SystemStats::hasAVX512VBMI | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Vector Bit Manipulation instructions are available.

Definition at line 130 of file juce_SystemStats.cpp.

## ◆ hasAVX512VL()

bool juce::SystemStats::hasAVX512VL | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Vector Length instructions are available.

Definition at line 131 of file juce_SystemStats.cpp.

## ◆ hasAVX512VPOPCNTDQ()

bool juce::SystemStats::hasAVX512VPOPCNTDQ | ( |  | ) |
| staticnoexcept

Returns true if Intel AVX-512 Vector Population Count Double and Quad-word instructions are available.

Definition at line 132 of file juce_SystemStats.cpp.

## ◆ hasFMA3()

bool juce::SystemStats::hasFMA3 | ( |  | ) |
| staticnoexcept

Returns true if AMD FMA3 instructions are available.

Definition at line 113 of file juce_SystemStats.cpp.

## ◆ hasFMA4()

bool juce::SystemStats::hasFMA4 | ( |  | ) |
| staticnoexcept

Returns true if AMD FMA4 instructions are available.

Definition at line 114 of file juce_SystemStats.cpp.

## ◆ hasMMX()

bool juce::SystemStats::hasMMX | ( |  | ) |
| staticnoexcept

Returns true if Intel MMX instructions are available.

Definition at line 111 of file juce_SystemStats.cpp.

## ◆ hasNeon()

bool juce::SystemStats::hasNeon | ( |  | ) |
| staticnoexcept

Returns true if ARM NEON instructions are available.

Definition at line 133 of file juce_SystemStats.cpp.

## ◆ hasSSE()

bool juce::SystemStats::hasSSE | ( |  | ) |
| staticnoexcept

Returns true if Intel SSE instructions are available.

Definition at line 115 of file juce_SystemStats.cpp.

## ◆ hasSSE2()

bool juce::SystemStats::hasSSE2 | ( |  | ) |
| staticnoexcept

Returns true if Intel SSE2 instructions are available.

Definition at line 116 of file juce_SystemStats.cpp.

## ◆ hasSSE3()

bool juce::SystemStats::hasSSE3 | ( |  | ) |
| staticnoexcept

Returns true if Intel SSE3 instructions are available.

Definition at line 117 of file juce_SystemStats.cpp.

## ◆ hasSSE41()

bool juce::SystemStats::hasSSE41 | ( |  | ) |
| staticnoexcept

Returns true if Intel SSE4.1 instructions are available.

Definition at line 119 of file juce_SystemStats.cpp.

## ◆ hasSSE42()

bool juce::SystemStats::hasSSE42 | ( |  | ) |
| staticnoexcept

Returns true if Intel SSE4.2 instructions are available.

Definition at line 120 of file juce_SystemStats.cpp.

## ◆ hasSSSE3()

bool juce::SystemStats::hasSSSE3 | ( |  | ) |
| staticnoexcept

Returns true if Intel SSSE3 instructions are available.

Definition at line 118 of file juce_SystemStats.cpp.

## ◆ isOperatingSystem64Bit()

static bool juce::SystemStats::isOperatingSystem64Bit | ( |  | ) |
| static

Returns true if the OS is 64-bit, or false for a 32-bit OS.

## ◆ isRunningInAppExtensionSandbox()

bool juce::SystemStats::isRunningInAppExtensionSandbox | ( |  | ) |
| staticnoexcept

Returns true if this code is running inside an app extension sandbox. This function will always return false on windows, linux and android.

Definition at line 226 of file juce_SystemStats.cpp.

## ◆ setApplicationCrashHandler()

void juce::SystemStats::setApplicationCrashHandler | ( | CrashHandlerFunction | handler | ) |
| static

Sets up a global callback function that will be called if the application executes some kind of illegal instruction.

You may want to call getStackBacktrace() in your handler function, to find out where the problem happened and log it, etc.

Definition at line 208 of file juce_SystemStats.cpp.

The documentation for this class was generated from the following files:

- juce_SystemStats.h
- juce_SystemStats.cpp