Index (Clarius Cast API Reference for Android)

A B C D E F G H I J L M N O P Q R S T U V W X Y Z
All Classes and Interfaces|All Packages

A

accept(boolean) - Method in interface me.clarius.sdk.Cast.BooleanResult: Called with the request result.
accept(boolean, int, boolean) - Method in interface me.clarius.sdk.Cast.ConnectionResult: Called with the request result.
accept(int) - Method in interface me.clarius.sdk.Cast.RequestRawDataCallback: Called with the request result.
accept(int) - Method in interface me.clarius.sdk.Cast.StartCaptureResult: Called with the request result.
accept(int, ByteBuffer) - Method in interface me.clarius.sdk.Cast.ReadRawDataCallback: Called with the request result.
accept(Optional<String>) - Method in interface me.clarius.sdk.Cast.FirmwareVersionResult: Called with the request result.
accept(Optional<ProbeInfo>) - Method in interface me.clarius.sdk.Cast.ProbeInfoResult: Called with the request result.
addImageOverlay(int, byte[], int, int, float, float, float, float) - Method in class me.clarius.sdk.Cast: Add an image overlay to a started capture
addLabelOverlay(int, String, double, double, double, double) - Method in class me.clarius.sdk.Cast: Add a label overlay to a started capture
addMeasurement(int, MeasurementType, String, PointF[]) - Method in class me.clarius.sdk.Cast: Add a measurement to a started capture
angle - Variable in class me.clarius.sdk.ProcessedImageInfo: acquisition angle for volumetric data.
angle - Variable in class me.clarius.sdk.RawImageInfo: acquisition angle for volumetric data.
AutoGain - Enum constant in enum class me.clarius.sdk.UserFunction: toggle auto gain.
ax - Variable in class me.clarius.sdk.PosInfo: Accelerometer x; acceleration is normalized to gravity [~9.81m/s^2] (m/s^2)/(m/s^2).
axialSize - Variable in class me.clarius.sdk.RawImageInfo: axial microns per sample.
ay - Variable in class me.clarius.sdk.PosInfo: Accelerometer y; acceleration is normalized to gravity [~9.81m/s^2] (m/s^2)/(m/s^2).
az - Variable in class me.clarius.sdk.PosInfo: Accelerometer z; acceleration is normalized to gravity [~9.81m/s^2] (m/s^2)/(m/s^2).

B

bitsPerPixel - Variable in class me.clarius.sdk.ProcessedImageInfo: bits per pixel.
bitsPerSample - Variable in class me.clarius.sdk.RawImageInfo: bits per sample.
bitsPerSample - Variable in class me.clarius.sdk.SpectralImageInfo: Bits per sample.
BMode - Enum constant in enum class me.clarius.sdk.UserFunction: enter b mode.
Button - Enum Class in me.clarius.sdk: The probe buttons.
ButtonDown - Enum constant in enum class me.clarius.sdk.Button: Down button.
ButtonHandle - Enum constant in enum class me.clarius.sdk.Button: Handle button (custom probes only).
buttonPressed(Button, int) - Method in interface me.clarius.sdk.Cast.Listener: Button callback function.
ButtonUp - Enum constant in enum class me.clarius.sdk.Button: Up button.

C

CaptureCine - Enum constant in enum class me.clarius.sdk.UserFunction: capture cine.
CaptureImage - Enum constant in enum class me.clarius.sdk.UserFunction: capture still image.
Cast - Class in me.clarius.sdk: Java interface for Clarius Cast.
Cast(Context, Cast.Listener) - Constructor for class me.clarius.sdk.Cast: Deprecated.
This constructor is no longer acceptable, use Cast(String, Listener) instead.
The Context object was used to obtain the path to the native JNI libraries, the new constructor lets user specify their own path if needed. The default path is: requireContext().getApplicationInfo().nativeLibraryDir.
Deprecated in version 10.3.0.
Cast(String, Cast.Listener) - Constructor for class me.clarius.sdk.Cast: Load the Clarius Cast library.
Cast.BooleanResult - Interface in me.clarius.sdk: Boolean result callback.
Cast.ConnectionResult - Interface in me.clarius.sdk: Connection callback.
Cast.FirmwareVersionResult - Interface in me.clarius.sdk: Firmware version callback.
Cast.Listener - Interface in me.clarius.sdk: Clarius Cast callbacks.
Cast.ProbeInfoResult - Interface in me.clarius.sdk: Probe info callback.
Cast.ReadRawDataCallback - Interface in me.clarius.sdk: Callback when the raw data was retrieved from the probe.
Cast.RequestRawDataCallback - Interface in me.clarius.sdk: Callback when the raw data request was completed.
Cast.StartCaptureResult - Interface in me.clarius.sdk: Capture creation callback.
CenterGuide - Enum constant in enum class me.clarius.sdk.UserFunction: toggle center guide.
ColorDoppler - Enum constant in enum class me.clarius.sdk.UserFunction: enter color doppler mode.
ColorGainDec - Enum constant in enum class me.clarius.sdk.UserFunction: decrease color gain.
ColorGainInc - Enum constant in enum class me.clarius.sdk.UserFunction: increase color gain.
ColorPrfDec - Enum constant in enum class me.clarius.sdk.UserFunction: decrease color prf.
ColorPrfInc - Enum constant in enum class me.clarius.sdk.UserFunction: increase color prf.
connect(String, int, Optional<Long>, String, Cast.ConnectionResult) - Method in class me.clarius.sdk.Cast: Connect to a probe that is on the same network as the caller.
CusMeasurementTypeDistance - Enum constant in enum class me.clarius.sdk.MeasurementType: point-to-point distance.
CusMeasurementTypeTraceArea - Enum constant in enum class me.clarius.sdk.MeasurementType: trace area.
CusMeasurementTypeTraceDistance - Enum constant in enum class me.clarius.sdk.MeasurementType: trace distance.

D

depth - Variable in class me.clarius.sdk.TgcInfo: Depth in millimeters.
DepthDec - Enum constant in enum class me.clarius.sdk.UserFunction: decrease depth.
DepthInc - Enum constant in enum class me.clarius.sdk.UserFunction: increase depth.
disconnect(Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Disconnect from an existing connection.
DynamicRngDec - Enum constant in enum class me.clarius.sdk.UserFunction: decrease dynamic range.
DynamicRngInc - Enum constant in enum class me.clarius.sdk.UserFunction: increase dynamic range.

E

elements - Variable in class me.clarius.sdk.ProbeInfo: Number of probe elements.
error(String) - Method in interface me.clarius.sdk.Cast.Listener: Error callback function.

F

finishCapture(int, Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Finish a previously started capture and send it to the app.
Flip - Enum constant in enum class me.clarius.sdk.UserFunction: toggle horizontal flip.
format - Variable in class me.clarius.sdk.ProcessedImageInfo: flag specifying the format of the image (see format definitions above).
fps - Variable in class me.clarius.sdk.ProcessedImageInfo: frame rate in hz.
fps - Variable in class me.clarius.sdk.RawImageInfo: frame rate in hz.
freeze(boolean) - Method in interface me.clarius.sdk.Cast.Listener: Freeze callback function.
Freeze - Enum constant in enum class me.clarius.sdk.UserFunction: toggle freeze.
FullScreen - Enum constant in enum class me.clarius.sdk.UserFunction: toggle full screen.

G

gain - Variable in class me.clarius.sdk.TgcInfo: Gain in decibels.
GainDec - Enum constant in enum class me.clarius.sdk.UserFunction: decrease gain.
GainInc - Enum constant in enum class me.clarius.sdk.UserFunction: increase gain.
getFirmwareVersion(Platform, Cast.FirmwareVersionResult) - Method in class me.clarius.sdk.Cast: Retrieve the firmware version for a given platform.
getProbeInfo(Cast.ProbeInfoResult) - Method in class me.clarius.sdk.Cast: Retrieve the probe info.
gx - Variable in class me.clarius.sdk.PosInfo: Gyroscope x; angular velocity is given in radians per second (RPS).
gy - Variable in class me.clarius.sdk.PosInfo: Gyroscope y; angular velocity is given in radians per second (RPS).
gz - Variable in class me.clarius.sdk.PosInfo: Gyroscope z; angular velocity is given in radians per second (RPS).

H

HD - Enum constant in enum class me.clarius.sdk.Platform: Second generation (HD).
HD3 - Enum constant in enum class me.clarius.sdk.Platform: Third generation (HD3).
height - Variable in class me.clarius.sdk.ProcessedImageInfo: height of the image in pixels.

I

ImageFormat - Enum Class in me.clarius.sdk: The compression types available.
imageSize - Variable in class me.clarius.sdk.ProcessedImageInfo: total size of image in bytes.
initialize(String, Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Initialize the Clarius Cast library to enable connection.
isConnected() - Method in class me.clarius.sdk.Cast: Check if Clarius Cast is currently connected to a probe.
isInitialized() - Method in class me.clarius.sdk.Cast: Check if Clarius Cast has been initialized.

J

jpeg - Variable in class me.clarius.sdk.RawImageInfo: size of the jpeg image, 0 if not a jpeg compressed image.
Jpeg - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent as a jpeg (with header).

L

lateralSize - Variable in class me.clarius.sdk.RawImageInfo: lateral microns per line.
LineF - Class in me.clarius.sdk: 2D line with double precision.
LineF() - Constructor for class me.clarius.sdk.LineF: Default constructor.
LineF(PointF, PointF) - Constructor for class me.clarius.sdk.LineF: Constructor with parameters.
lines - Variable in class me.clarius.sdk.RawImageInfo: number of ultrasound lines in the image.
lines - Variable in class me.clarius.sdk.SpectralImageInfo: Number of lines in the block.

M

me.clarius.sdk - package me.clarius.sdk
MeasurementType - Enum Class in me.clarius.sdk: Supported measurement types.
micronsPerPixel - Variable in class me.clarius.sdk.ProcessedImageInfo: microns per pixel (always 1:1 aspect ratio axially/laterally).
micronsPerSample - Variable in class me.clarius.sdk.SpectralImageInfo: Microns per pixel/sample in an M spectrum.
MMode - Enum constant in enum class me.clarius.sdk.UserFunction: enter m mode.
mx - Variable in class me.clarius.sdk.PosInfo: Magnetometer x; magnetic flux density is normalized to the earth's field [~50 mT] (T/T).
my - Variable in class me.clarius.sdk.PosInfo: Magnetometer y; magnetic flux density is normalized to the earth's field [~50 mT] (T/T).
mz - Variable in class me.clarius.sdk.PosInfo: Magnetometer z; magnetic flux density is normalized to the earth's field [~50 mT] (T/T).

N

NeedleEnhance - Enum constant in enum class me.clarius.sdk.UserFunction: enter needle enhance mode (when available).
NeedleSide - Enum constant in enum class me.clarius.sdk.UserFunction: toggle needle enhance side.
newImuDataFn(PosInfo[]) - Method in interface me.clarius.sdk.Cast.Listener: New imu data callback function.
newProcessedImage(ByteBuffer, ProcessedImageInfo, PosInfo[]) - Method in interface me.clarius.sdk.Cast.Listener: New processed image callback function.
newRawImageFn(ByteBuffer, RawImageInfo, PosInfo[]) - Method in interface me.clarius.sdk.Cast.Listener: New raw image callback function.
newSpectralImageFn(ByteBuffer, SpectralImageInfo) - Method in interface me.clarius.sdk.Cast.Listener: New spectral image callback function.

O

originX - Variable in class me.clarius.sdk.ProcessedImageInfo: image origin in microns in the horizontal axis.
originY - Variable in class me.clarius.sdk.ProcessedImageInfo: image origin in microns in the vertical axis.
overlay - Variable in class me.clarius.sdk.ProcessedImageInfo: flag that the image is an overlay without grayscale (ie.

P

p1 - Variable in class me.clarius.sdk.LineF: First point in the line.
p2 - Variable in class me.clarius.sdk.LineF: Second point in the line.
period - Variable in class me.clarius.sdk.SpectralImageInfo: Line acquisition period in seconds.
pitch - Variable in class me.clarius.sdk.ProbeInfo: Element pitch.
Platform - Enum Class in me.clarius.sdk: Major Clarius platforms.
PlayCine - Enum constant in enum class me.clarius.sdk.UserFunction: play cine when frozen.
Png - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent as a png (with header).
PointF - Class in me.clarius.sdk: 2D point with double precision.
PointF() - Constructor for class me.clarius.sdk.PointF: Default constructor.
PointF(double, double) - Constructor for class me.clarius.sdk.PointF: Constructor with parameters.
PosInfo - Class in me.clarius.sdk: Positional data information structure.
PosInfo() - Constructor for class me.clarius.sdk.PosInfo: Default constructor.
PosInfo(long, double, double, double, double, double, double, double, double, double, double, double, double, double) - Constructor for class me.clarius.sdk.PosInfo: Constructor with parameters.
PowerDoppler - Enum constant in enum class me.clarius.sdk.UserFunction: enter power doppler mode.
ProbeInfo - Class in me.clarius.sdk: Probe information.
ProbeInfo() - Constructor for class me.clarius.sdk.ProbeInfo: Default constructor.
ProbeInfo(int, int, int, int) - Constructor for class me.clarius.sdk.ProbeInfo: Constructor with parameters.
ProcessedImageInfo - Class in me.clarius.sdk: Processed image information supplied with each frame.
ProcessedImageInfo() - Constructor for class me.clarius.sdk.ProcessedImageInfo: Default constructor.
ProcessedImageInfo(int, int, int, int, double, double, double, long, double, double, int, ImageFormat, TgcInfo[]) - Constructor for class me.clarius.sdk.ProcessedImageInfo: Constructor with parameters.
progress(int) - Method in interface me.clarius.sdk.Cast.Listener: Progress callback function.
pw - Variable in class me.clarius.sdk.SpectralImageInfo: Flag specifying the data is PW and not M.
PwDoppler - Enum constant in enum class me.clarius.sdk.UserFunction: enter pulsed wave doppler mode (when available).

Q

qw - Variable in class me.clarius.sdk.PosInfo: W component (real) of the orientation quaternion.
qx - Variable in class me.clarius.sdk.PosInfo: X component (imaginary) of the orientation quaternion.
qy - Variable in class me.clarius.sdk.PosInfo: Y component (imaginary) of the orientation quaternion.
qz - Variable in class me.clarius.sdk.PosInfo: Z component (imaginary) of the orientation quaternion.

R

radius - Variable in class me.clarius.sdk.ProbeInfo: Radius in millimeters.
RawImageInfo - Class in me.clarius.sdk: Raw image information supplied with each frame.
RawImageInfo() - Constructor for class me.clarius.sdk.RawImageInfo: Default constructor.
RawImageInfo(int, int, int, double, double, long, int, int, double, double, TgcInfo[]) - Constructor for class me.clarius.sdk.RawImageInfo: Constructor with parameters.
readRawData(Cast.ReadRawDataCallback) - Method in class me.clarius.sdk.Cast: Retrieve raw data from a previous request.
release() - Method in class me.clarius.sdk.Cast: Unload the Clarius Cast library, any subsequent call will be no-op.
requestRawData(long, long, Cast.RequestRawDataCallback) - Method in class me.clarius.sdk.Cast: Request raw data from the probe.
rf - Variable in class me.clarius.sdk.RawImageInfo: flag specifying data is rf and not envelope.
RfMode - Enum constant in enum class me.clarius.sdk.UserFunction: enter rf mode (when available).

S

samples - Variable in class me.clarius.sdk.RawImageInfo: number of samples per line in the image.
samples - Variable in class me.clarius.sdk.SpectralImageInfo: Number of samples per line.
separateOverlays(boolean) - Method in class me.clarius.sdk.Cast: Set a flag to separate overlays into separate images.
SetDepth - Enum constant in enum class me.clarius.sdk.UserFunction: set depth in cm.
setFormat(ImageFormat) - Method in class me.clarius.sdk.Cast: Set the format for processed images, by default the format will be uncompressed ARGB32.
SetGain - Enum constant in enum class me.clarius.sdk.UserFunction: set gain in %.
setOutputSize(int, int) - Method in class me.clarius.sdk.Cast: Set the dimensions of the output display for scan conversion.
SpectralImageInfo - Class in me.clarius.sdk: Spectral image information supplied with each block.
SpectralImageInfo() - Constructor for class me.clarius.sdk.SpectralImageInfo: Default constructor.
SpectralImageInfo(int, int, int, double, double, double, int) - Constructor for class me.clarius.sdk.SpectralImageInfo: Constructor with parameters.
startCapture(long, Cast.StartCaptureResult) - Method in class me.clarius.sdk.Cast: Create a capture request locally for sending to the app.
Strain - Enum constant in enum class me.clarius.sdk.UserFunction: enter strain elastography mode (when available).
SwitchArray - Enum constant in enum class me.clarius.sdk.UserFunction: switch array.

T

tgc - Variable in class me.clarius.sdk.ProcessedImageInfo: tgc points.
tgc - Variable in class me.clarius.sdk.RawImageInfo: tgc points.
TgcInfo - Class in me.clarius.sdk: TGC information.
TgcInfo() - Constructor for class me.clarius.sdk.TgcInfo: Default constructor.
TgcInfo(double, double) - Constructor for class me.clarius.sdk.TgcInfo: Constructor with parameters.
tm - Variable in class me.clarius.sdk.PosInfo: Timestamp in nanoseconds.
tm - Variable in class me.clarius.sdk.ProcessedImageInfo: timestamp of images.
tm - Variable in class me.clarius.sdk.RawImageInfo: timestamp of image.

U

Uncompressed - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent in a raw and uncompressed in 32 bits ARGB.
Uncompressed8Bit - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent in a raw and uncompressed in 8 bit grayscale.
userFunction(UserFunction, double, Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Perform a user function on a connected probe.
UserFunction - Enum Class in me.clarius.sdk: The possible user functions from a button, foot pedal, or listener.

V

V1 - Enum constant in enum class me.clarius.sdk.Platform: First generation.
valueOf(String) - Static method in enum class me.clarius.sdk.Button: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ImageFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.MeasurementType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.Platform: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.UserFunction: Returns the enum constant of this class with the specified name.
values() - Static method in enum class me.clarius.sdk.Button: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ImageFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.MeasurementType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.Platform: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.UserFunction: Returns an array containing the constants of this enum class, in the order they are declared.
velocityPerSample - Variable in class me.clarius.sdk.SpectralImageInfo: Velocity in m/s per pixel/sample in a PW spectrum.
version - Variable in class me.clarius.sdk.ProbeInfo: Version (1 = clarius 1st generation, 2 = clarius HD, 3 = clarius HD3).
VoiceCommand - Enum constant in enum class me.clarius.sdk.UserFunction: toggle voice controls.

W

width - Variable in class me.clarius.sdk.ProcessedImageInfo: width of the image in pixels.

X

x - Variable in class me.clarius.sdk.PointF: X coordinate.

Y

y - Variable in class me.clarius.sdk.PointF: Y coordinate.

Z

Zoom - Enum constant in enum class me.clarius.sdk.UserFunction: toggle zoom.

A B C D E F G H I J L M N O P Q R S T U V W X Y Z
All Classes and Interfaces|All Packages