Skip to content

Commit c2c194d

Browse files
committed
2 parents 89ec851 + 75d25bd commit c2c194d

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

lib/bigbluebutton_api.rb

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,30 @@ def get_recordings(options={})
469469
response
470470
end
471471

472+
# Available since BBB v1.1
473+
# Update metadata (or other attributes depending on the API implementation) for a given recordID (or set of record IDs).
474+
# recordIDs (string, Array):: ID or IDs of the target recordings.
475+
# Any of the following values are accepted:
476+
# "id1"
477+
# "id1,id2,id3"
478+
# ["id1"]
479+
# ["id1", "id2", "id3"]
480+
# meta (String):: Pass one or more metadata values to be update (format is the same as in create call)
481+
# options (Hash):: Hash with additional parameters. This method doesn't accept additional
482+
# parameters, but if you have a custom API with more parameters, you
483+
# can simply pass them in this hash and they will be added to the API call.
484+
#
485+
# === Example responses
486+
#
487+
# { :returncode => success, :updated => true }
488+
#
489+
def update_recordings(recordIDs, meta=nil, options={})
490+
recordIDs = recordIDs.join(",") if recordIDs.instance_of?(Array) # ["id1", "id2"] becomes "id1,id2"
491+
params = { :recordID => recordIDs, :meta => meta }.merge(options)
492+
send_api_request(:updateRecordings, params)
493+
end
494+
495+
472496
# Publish and unpublish recordings for a given recordID (or set of record IDs).
473497
# recordIDs (string, Array):: ID or IDs of the target recordings.
474498
# Any of the following values are accepted:

0 commit comments

Comments
 (0)