153a5a1b3Sopenharmony_ciMessage API reference 253a5a1b3Sopenharmony_ci 353a5a1b3Sopenharmony_ciThe message API allows any object within pulseaudio to register a message 453a5a1b3Sopenharmony_cihandler. A message handler is a function that can be called by clients using 553a5a1b3Sopenharmony_ciPA_COMMAND_SEND_OBJECT_MESSAGE. A message consists at least of an object path 653a5a1b3Sopenharmony_ciand a message command, both specified as strings. Additional parameters can 753a5a1b3Sopenharmony_cibe specified using a single string in JSON format, but are not mandatory. 853a5a1b3Sopenharmony_ci 953a5a1b3Sopenharmony_ciThe message handler returns an error number as defined in def.h and also returns 1053a5a1b3Sopenharmony_cia string in the "response" variable. Non-empty response will be in JSON format. 1153a5a1b3Sopenharmony_ci 1253a5a1b3Sopenharmony_ciThe reference further down lists available messages, their parameters 1353a5a1b3Sopenharmony_ciand return values. 1453a5a1b3Sopenharmony_ci 1553a5a1b3Sopenharmony_ciReference: 1653a5a1b3Sopenharmony_ci 1753a5a1b3Sopenharmony_ciObject path: /core 1853a5a1b3Sopenharmony_ciMessage: list-handlers 1953a5a1b3Sopenharmony_ciParameters: None 2053a5a1b3Sopenharmony_ciReturn value: JSON array of handler description objects 2153a5a1b3Sopenharmony_ci [{"name":"Handler name","description":"Description"} ...] 2253a5a1b3Sopenharmony_ci 2353a5a1b3Sopenharmony_ciObject path: /card/bluez_card.XX_XX_XX_XX_XX_XX/bluez 2453a5a1b3Sopenharmony_ciMessage: list-codecs 2553a5a1b3Sopenharmony_ciParameters: None 2653a5a1b3Sopenharmony_ciReturn value: JSON array of codec description objects 2753a5a1b3Sopenharmony_ci [{"name":"codec1","description":"Codec 1"} ...] 2853a5a1b3Sopenharmony_ci 2953a5a1b3Sopenharmony_ciObject path: /card/bluez_card.XX_XX_XX_XX_XX_XX/bluez 3053a5a1b3Sopenharmony_ciMessage: get-codec 3153a5a1b3Sopenharmony_ciParameters: None 3253a5a1b3Sopenharmony_ciReturn value: "codec name" 3353a5a1b3Sopenharmony_ci 3453a5a1b3Sopenharmony_ciObject path: /card/bluez_card.XX_XX_XX_XX_XX_XX/bluez 3553a5a1b3Sopenharmony_ciMessage: switch-codec 3653a5a1b3Sopenharmony_ciParameters: "codec name" 3753a5a1b3Sopenharmony_ciReturn value: none 3853a5a1b3Sopenharmony_ci 3953a5a1b3Sopenharmony_ciDescription: Set if card profile selection should be sticky instead of being automated 4053a5a1b3Sopenharmony_ciObject path: /card/<card_name> 4153a5a1b3Sopenharmony_ciMessage: set-profile-sticky 4253a5a1b3Sopenharmony_ciParameters: JSON "true" or "false" 4353a5a1b3Sopenharmony_ciReturn value: none 4453a5a1b3Sopenharmony_ci 4553a5a1b3Sopenharmony_ciDescription: Get if card profile selection should be sticky instead of being automated 4653a5a1b3Sopenharmony_ciObject path: /card/<card_name> 4753a5a1b3Sopenharmony_ciMessage: get-profile-sticky 4853a5a1b3Sopenharmony_ciParameters: None 4953a5a1b3Sopenharmony_ciReturn value: JSON "true" or "false" 50