public class AgoraParameter
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
private long |
nativeHandle |
| Constructor and Description |
|---|
AgoraParameter(long handle)
Constructs an AgoraParameter instance.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
convertPath(java.lang.String filePath)
Converts a file path to a platform-specific format.
|
java.lang.String |
getArray(java.lang.String key,
java.lang.String args)
Retrieves an array parameter value as a JSON string.
|
boolean |
getBool(java.lang.String key)
Retrieves a boolean parameter value.
|
int |
getInt(java.lang.String key)
Retrieves an integer parameter value.
|
double |
getNumber(java.lang.String key)
Retrieves a floating-point number parameter value.
|
java.lang.String |
getObject(java.lang.String key)
Retrieves an object parameter value as a JSON string.
|
java.lang.String |
getString(java.lang.String key)
Retrieves a string parameter value.
|
int |
getUInt(java.lang.String key)
Retrieves an unsigned integer parameter value.
|
private java.lang.String |
nativeConvertPath(long nativeHandle,
java.lang.String filePath) |
private java.lang.String |
nativeGetArray(long nativeHandle,
java.lang.String key,
java.lang.String args) |
private boolean |
nativeGetBool(long nativeHandle,
java.lang.String key) |
private int |
nativeGetInt(long nativeHandle,
java.lang.String key) |
private double |
nativeGetNumber(long nativeHandle,
java.lang.String key) |
private java.lang.String |
nativeGetObject(long nativeHandle,
java.lang.String key) |
private java.lang.String |
nativeGetString(long nativeHandle,
java.lang.String key) |
private int |
nativeGetUInt(long nativeHandle,
java.lang.String key) |
private void |
nativeRelease(long nativeHandle) |
private int |
nativeSetArray(long nativeHandle,
java.lang.String key,
java.lang.String value) |
private int |
nativeSetBool(long nativeHandle,
java.lang.String key,
boolean value) |
private int |
nativeSetInt(long nativeHandle,
java.lang.String key,
int value) |
private int |
nativeSetNumber(long nativeHandle,
java.lang.String key,
double value) |
private int |
nativeSetObject(long nativeHandle,
java.lang.String key,
java.lang.String value) |
private int |
nativeSetParameters(long nativeHandle,
java.lang.String parameters) |
private int |
nativeSetString(long nativeHandle,
java.lang.String key,
java.lang.String value) |
private int |
nativeSetUInt(long nativeHandle,
java.lang.String key,
int value) |
void |
release()
Releases all resources associated with this parameter instance.
|
int |
setArray(java.lang.String key,
java.lang.String value)
Sets an array parameter value in JSON format.
|
int |
setBool(java.lang.String key,
boolean value)
Sets a boolean parameter value.
|
int |
setInt(java.lang.String key,
int value)
Sets an integer parameter value.
|
int |
setNumber(java.lang.String key,
double value)
Sets a floating-point number parameter value.
|
int |
setObject(java.lang.String key,
java.lang.String value)
Sets an object parameter value in JSON format.
|
int |
setParameters(java.lang.String parameters)
Sets multiple parameters at once using a JSON string.
|
int |
setString(java.lang.String key,
java.lang.String value)
Sets a string parameter value.
|
int |
setUInt(java.lang.String key,
int value)
Sets an unsigned integer parameter value.
|
public AgoraParameter(long handle)
handle - The native handle for the parameter instancepublic void release()
public int setBool(java.lang.String key,
boolean value)
key - The parameter keyvalue - The boolean value to setpublic int setInt(java.lang.String key,
int value)
key - The parameter keyvalue - The integer value to setpublic int setUInt(java.lang.String key,
int value)
key - The parameter keyvalue - The unsigned integer value to setpublic int setNumber(java.lang.String key,
double value)
key - The parameter keyvalue - The double value to setpublic int setString(java.lang.String key,
java.lang.String value)
key - The parameter keyvalue - The string value to setpublic int setObject(java.lang.String key,
java.lang.String value)
key - The parameter keyvalue - The JSON string representing the objectpublic int setArray(java.lang.String key,
java.lang.String value)
key - The parameter keyvalue - The JSON string representing the arraypublic boolean getBool(java.lang.String key)
key - The parameter keyjava.lang.IllegalStateException - if the parameter cannot be retrievedpublic int getInt(java.lang.String key)
key - The parameter keyjava.lang.IllegalStateException - if the parameter cannot be retrievedpublic int getUInt(java.lang.String key)
key - The parameter keyjava.lang.IllegalStateException - if the parameter cannot be retrievedpublic double getNumber(java.lang.String key)
key - The parameter keyjava.lang.IllegalStateException - if the parameter cannot be retrievedpublic java.lang.String getString(java.lang.String key)
key - The parameter keypublic java.lang.String getObject(java.lang.String key)
key - The parameter keypublic java.lang.String getArray(java.lang.String key,
java.lang.String args)
key - The parameter keyargs - Additional arguments for array retrievalpublic int setParameters(java.lang.String parameters)
parameters - A JSON string containing multiple parameter key-value pairspublic java.lang.String convertPath(java.lang.String filePath)
filePath - The original file path to convertprivate void nativeRelease(long nativeHandle)
private int nativeSetBool(long nativeHandle,
java.lang.String key,
boolean value)
private int nativeSetInt(long nativeHandle,
java.lang.String key,
int value)
private int nativeSetUInt(long nativeHandle,
java.lang.String key,
int value)
private int nativeSetNumber(long nativeHandle,
java.lang.String key,
double value)
private int nativeSetString(long nativeHandle,
java.lang.String key,
java.lang.String value)
private int nativeSetObject(long nativeHandle,
java.lang.String key,
java.lang.String value)
private int nativeSetArray(long nativeHandle,
java.lang.String key,
java.lang.String value)
private boolean nativeGetBool(long nativeHandle,
java.lang.String key)
private int nativeGetInt(long nativeHandle,
java.lang.String key)
private int nativeGetUInt(long nativeHandle,
java.lang.String key)
private double nativeGetNumber(long nativeHandle,
java.lang.String key)
private java.lang.String nativeGetString(long nativeHandle,
java.lang.String key)
private java.lang.String nativeGetObject(long nativeHandle,
java.lang.String key)
private java.lang.String nativeGetArray(long nativeHandle,
java.lang.String key,
java.lang.String args)
private int nativeSetParameters(long nativeHandle,
java.lang.String parameters)
private java.lang.String nativeConvertPath(long nativeHandle,
java.lang.String filePath)