Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.18.0: changeRecording & reorderSliceRecordings #27

Merged
merged 2 commits into from
Nov 26, 2021
Merged

Conversation

ericcarraway
Copy link
Owner

Description:

This PR adds two new methods.

reorderSliceRecordings(paramsObj)

  • Reorder a slice's recordings.
  • Sets the order of the recordings in the slice with a given scorehash.
  • Soundslice documentation: "Reorder slice’s recordings"
apiClient.reorderSliceRecordings({
  // The slice whose recordings you'd like to reorder.
  scorehash: 'abcde',
  // An array of recording IDs in your requested order.
  // **OR** a string of recording IDs separated by commas.
  //
  // The first recording ID is the top-most recording in the Soundslice UI, and so forth.
  // The last recording ID is the default.
  // Every recording in the slice must be included in this data.
  order: [222226, 222227, 222225],
  // Optionally, pass a comma-delimited string:
  // order: '222226,222227,222225'
})

changeRecording(paramsObj)

  • Changes data for the recording with ID recordingId.
  • It's possible change a recording's name, and/or source_data, and/or hls_url.
  • Makes a POST request with the given parameters.
  • Other than recordingId, all params are optional.
  • If you don’t want to change a particular value, simply don't send its key with the request.
  • Soundslice documentation: "Change recording"
apiClient.changeRecording({
  // Required
  recordingId: 123456,
  // The attribute of the recording that you'd like to change.
  name: 'Changed Recording Name',
  // Optionally, 'source_data' can be changed if `source` is 3 or 8.
  // Optionally, 'hls_url' can be changed if `source` is 3.
})

Closes #11

@ericcarraway ericcarraway merged commit 0017f0b into main Nov 26, 2021
@ericcarraway ericcarraway deleted the 0.18.0 branch November 26, 2021 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add method to change a recording
1 participant